docs/file.README.html in ec2-host-0.5.0 vs docs/file.README.html in ec2-host-0.5.1
- old
+ new
@@ -83,24 +83,26 @@
using thease tags with this gem.</p>
<h2 id="label-Configuration">Configuration</h2>
<p>You can write a configuration file located at
-<code>/etc/sysconfig/ec2-host</code> (You can configure this path by
-<code>EC2_HOST_CONFIG_FILE</code> environment variable), or as environment
-variables:</p>
+<code>/etc/sysconfig/ec2-host</code> or <code>/etc/default/ec2-host</code>
+(You can configure this path by <code>EC2_HOST_CONFIG_FILE</code>
+environment variable), or as environment variables:</p>
<p>AWS SDK (CLI) parameters:</p>
<ul><li>
<p><strong>AWS_ACCESS_KEY_ID</strong>: AWS SDK (CLI) crendentials. Default
loads a credentials file</p>
</li><li>
<p><strong>AWS_SECRET_ACCESS_KEY</strong>: AWS SDK (CLI) credentials. Default
load a credentials file</p>
</li><li>
<p><strong>AWS_DEFAULT_REGION</strong> (<strong>AWS_REGION</strong>); AWS SDK
-(CLI) region such as <code>ap-northeast-1</code>, <code>us-east-1</code>.</p>
+(CLI) region such as <code>ap-northeast-1</code>, <code>us-east-1</code>.
+Default obtains from <code>$HOME/.aws/config</code> with profile
+<code>AWS_DEFAULT_PROFILE</code>.</p>
</li><li>
<p><strong>AWS_DEFAULT_PROFILE</strong> (<strong>AWS_PROFILE</strong>): The
profile key of the AWS SDK (CLI) credentails file. Default is
<code>default</code></p>
</li><li>
@@ -141,10 +143,13 @@
<code>ARRAY_TAG_DELIMITER</code> (default: <code>,</code>)</p>
</li><li>
<p><strong>ARRAY_TAG_DELIMITER (optional)</strong>: A delimiter to express
array. Default is <code>,</code></p>
</li><li>
+<p><strong>ROLE_MAX_DEPTH (optional)</strong>: The maximum depth of levels of
+roles. Default is 3.</p>
+</li><li>
<p><strong>LOG_LEVEL (optional)</strong>: Log level such as <code>info</code>,
<code>debug</code>, <code>error</code>. The default is <code>info</code>.</p>
</li></ul>
<p>See <a href="./example/example.conf">example.conf</a></p>
@@ -213,13 +218,13 @@
<pre class="code ruby"><code class="ruby">$ bin/ec2-host --help
Usage: ec2-host [options]
--hostname one,two,three name or private_dns_name
-r, --role one,two,three role
- --r1, --role1 one,two,three role1, the 1st part of role delimited by :
- --r2, --role2 one,two,three role2, the 2st part of role delimited by :
- --r3, --role3 one,two,three role3, the 3st part of role delimited by :
+ --r1, --role1 one,two,three role1, 1th part of role delimited by :
+ --r2, --role2 one,two,three role2, 2th part of role delimited by :
+ --r3, --role3 one,two,three role3, 3th part of role delimited by :
--instance-id one,two,three instance_id
--state one,two,three filter with instance state (default: running)
--monitoring one,two,three filter with instance monitoring
-a, --all list all hosts (remove default filter)
--private-ip, --ip show private ip address instead of hostname
@@ -312,10 +317,10 @@
<p>See <a href="LICENSE">LICENSE</a></p>
</div></div>
<div id="footer">
- Generated on Thu Nov 24 10:25:36 2016 by
+ Generated on Fri Dec 2 11:53:59 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.2).
</div>
</body>
\ No newline at end of file