Merge pull request #193 from asteris-llc/feature/docker-image-docs

resources(docker image): document
asteris-llc · Aug 29, 2016 · 09eba13 · 09eba13
2 parents de8f521 + de9488d
commit 09eba13
Show file tree

Hide file tree

Showing 23 changed files with 917 additions and 75 deletions.
diff --git a/docs/dependencies/index.html b/docs/dependencies/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content

diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content

diff --git a/docs/index.html b/docs/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content

diff --git a/docs/index.xml b/docs/index.xml
@@ -6,9 +6,56 @@
     <description>Recent content on Converge</description>
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>
-    <lastBuildDate>Thu, 25 Aug 2016 10:03:34 -0500</lastBuildDate>
+    <lastBuildDate>Thu, 25 Aug 2016 12:19:27 -0400</lastBuildDate>
     <atom:link href="http://converge.aster.is/index.xml" rel="self" type="application/rss+xml" />
 
+    <item>
+      <title>docker.image</title>
+      <link>http://converge.aster.is/resources/docker-image/</link>
+      <pubDate>Thu, 25 Aug 2016 12:19:27 -0400</pubDate>
+
+      <guid>http://converge.aster.is/resources/docker-image/</guid>
+      <description>
+
+&lt;p&gt;Image is responsible for pulling Docker images. It assumes that there is
+already a Docker daemon running on the system.&lt;/p&gt;
+
+&lt;h2 id=&#34;example&#34;&gt;Example&lt;/h2&gt;
+
+&lt;pre&gt;&lt;code class=&#34;language-hcl&#34;&gt;docker.image &amp;quot;busybox&amp;quot; {
+  name               = &amp;quot;busybox&amp;quot;
+  tag                = &amp;quot;latest&amp;quot;
+  inactivity_timeout = &amp;quot;60s&amp;quot;
+}
+
+&lt;/code&gt;&lt;/pre&gt;
+
+&lt;h2 id=&#34;parameters&#34;&gt;Parameters&lt;/h2&gt;
+
+&lt;ul&gt;
+&lt;li&gt;&lt;code&gt;name&lt;/code&gt; (string)&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;p&gt;name of the image to pull&lt;/p&gt;
+
+&lt;ul&gt;
+&lt;li&gt;&lt;code&gt;tag&lt;/code&gt; (string)&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;p&gt;tag of the image to pull&lt;/p&gt;
+
+&lt;ul&gt;
+&lt;li&gt;&lt;code&gt;inactivity_timeout&lt;/code&gt; (duration_string)&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;p&gt;the amount of time to wait after a period of inactivity. The timeout is
+reset each time new data arrives. The format is Go&amp;rsquo;s duration string. A
+duration string is a possibly signed sequence of decimal numbers, each with
+optional fraction and a unit suffix, such as &amp;ldquo;300ms&amp;rdquo;, &amp;ldquo;-1.5h&amp;rdquo; or &amp;ldquo;2h45m&amp;rdquo;.
+Valid time units are &amp;ldquo;ns&amp;rdquo;, &amp;ldquo;us&amp;rdquo; (or &amp;ldquo;µs&amp;rdquo;), &amp;ldquo;ms&amp;rdquo;, &amp;ldquo;s&amp;rdquo;, &amp;ldquo;m&amp;rdquo;, &amp;ldquo;h&amp;rdquo;.&lt;/p&gt;
+</description>
+    </item>
+
     <item>
       <title>task</title>
       <link>http://converge.aster.is/resources/task/</link>

diff --git a/docs/install/index.html b/docs/install/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content

diff --git a/docs/license/index.html b/docs/license/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content

diff --git a/docs/organization/index.html b/docs/organization/index.html
@@ -291,6 +291,19 @@
 
 
 
+<a  title="docker.image" href="http://converge.aster.is/resources/docker-image/">
+
+  docker.image
+</a>
+
+
+
+
+
+
+
+
+
 <a  title="file.content" href="http://converge.aster.is/resources/file-content/">
 
   file.content