add docs

tilt-dev · Jan 11, 2019 · f87c12e · f87c12e
1 parent af07a62
commit f87c12e
Show file tree

Hide file tree

Showing 14 changed files with 133 additions and 98 deletions.
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/write_your_tiltfile.doctree b/docs/_build/doctrees/write_your_tiltfile.doctree
diff --git a/docs/_build/html/_sources/write_your_tiltfile.md.txt b/docs/_build/html/_sources/write_your_tiltfile.md.txt
@@ -18,6 +18,9 @@ k8s_yaml(['foo.yaml', 'bar.yaml'])
 # run kustomize to generate yaml
 k8s_yaml(kustomize('config_dir'))
 
+# run helm to generate yaml
+k8s_yaml(helm('chart_dir'))
+
 # run a custom command to generate yaml
 k8s_yaml(local('gen_k8s_yaml.py'))
 
@@ -38,7 +41,7 @@ docker_build("companyname/graphql", "graphql", args={"target": "local"})
 k8s_resource("backend", image="companyname/backend/server")
 
 # connect to a specific local port
-k8s_resource("frontend", port_forwards=9000) 
+k8s_resource("frontend", port_forwards=9000)
 ```
 
 Let's dig in to each of these sections in detail.
@@ -122,7 +125,7 @@ You can also add a Kubernetes port forward to this resource.
 
 ```python
 # connect to a specific local port
-k8s_resource("backend", image="companyname/backend/server", port_forwards=9000) 
+k8s_resource("backend", image="companyname/backend/server", port_forwards=9000)
 ```
 
 ## Next steps

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -233,6 +233,20 @@
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="api.helm">
+<code class="descclassname">api.</code><code class="descname">helm</code><span class="sig-paren">(</span><em>pathToChartDir</em><span class="sig-paren">)</span><a class="headerlink" href="#api.helm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run <a class="reference external" href="https://docs.helm.sh/helm/#helm-template">helm template</a> on a given directory that contains a chart and return the fully rendered YAML as a Blob</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.Blob" title="api.Blob"><code class="xref py py-class docutils literal notranslate"><span class="pre">Blob</span></code></a></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="function">
 <dt id="api.k8s_resource">
 <code class="descclassname">api.</code><code class="descname">k8s_resource</code><span class="sig-paren">(</span><em>name</em>, <em>yaml=''</em>, <em>image=''</em>, <em>port_forwards=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#api.k8s_resource" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/_build/html/first_config.html b/docs/_build/html/first_config.html
@@ -228,35 +228,35 @@
 <p>This next line reads Kubernetes YAML, gives it a name, creates it in Kubernetes, and sets up a localhost:8100 listener.</p>
 <p>Tilt tracks dependencies; you can edit YAML, Dockerfiles or the Tiltfile and Tilt will automatically rebuild your server.</p>
 <p>At the risk of diving too deep, let’s unpack that YAML file.</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">apiVersion</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
-<span class="l l-Scalar l-Scalar-Plain">kind</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Namespace</span>
-<span class="l l-Scalar l-Scalar-Plain">metadata</span><span class="p p-Indicator">:</span>
-  <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
-  <span class="l l-Scalar l-Scalar-Plain">labels</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
+<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Namespace</span>
+<span class="nt">metadata</span><span class="p">:</span>
+  <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
+  <span class="nt">labels</span><span class="p">:</span>
+    <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
 <span class="nn">---</span>
-<span class="l l-Scalar l-Scalar-Plain">apiVersion</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">apps/v1</span>
-<span class="l l-Scalar l-Scalar-Plain">kind</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Deployment</span>
-<span class="l l-Scalar l-Scalar-Plain">metadata</span><span class="p p-Indicator">:</span>
-  <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
-  <span class="l l-Scalar l-Scalar-Plain">namespace</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
-  <span class="l l-Scalar l-Scalar-Plain">labels</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">app</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
-<span class="l l-Scalar l-Scalar-Plain">spec</span><span class="p p-Indicator">:</span>
-  <span class="l l-Scalar l-Scalar-Plain">selector</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">matchLabels</span><span class="p p-Indicator">:</span>
-      <span class="l l-Scalar l-Scalar-Plain">app</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
-  <span class="l l-Scalar l-Scalar-Plain">template</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">metadata</span><span class="p p-Indicator">:</span>
-      <span class="l l-Scalar l-Scalar-Plain">labels</span><span class="p p-Indicator">:</span>
-        <span class="l l-Scalar l-Scalar-Plain">app</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
-    <span class="l l-Scalar l-Scalar-Plain">spec</span><span class="p p-Indicator">:</span>
-      <span class="l l-Scalar l-Scalar-Plain">containers</span><span class="p p-Indicator">:</span>
-      <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
-        <span class="l l-Scalar l-Scalar-Plain">image</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">gcr.io/windmill-test-containers/integration/oneup</span>
-        <span class="l l-Scalar l-Scalar-Plain">command</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">&quot;/go/bin/oneup&quot;</span><span class="p p-Indicator">]</span>
-        <span class="l l-Scalar l-Scalar-Plain">ports</span><span class="p p-Indicator">:</span>
-        <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">containerPort</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">8000</span>
+<span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">apps/v1</span>
+<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Deployment</span>
+<span class="nt">metadata</span><span class="p">:</span>
+  <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
+  <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">tilt-integration</span>
+  <span class="nt">labels</span><span class="p">:</span>
+    <span class="nt">app</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
+<span class="nt">spec</span><span class="p">:</span>
+  <span class="nt">selector</span><span class="p">:</span>
+    <span class="nt">matchLabels</span><span class="p">:</span>
+      <span class="nt">app</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
+  <span class="nt">template</span><span class="p">:</span>
+    <span class="nt">metadata</span><span class="p">:</span>
+      <span class="nt">labels</span><span class="p">:</span>
+        <span class="nt">app</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
+    <span class="nt">spec</span><span class="p">:</span>
+      <span class="nt">containers</span><span class="p">:</span>
+      <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oneup</span>
+        <span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gcr.io/windmill-test-containers/integration/oneup</span>
+        <span class="nt">command</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">&quot;/go/bin/oneup&quot;</span><span class="p p-Indicator">]</span>
+        <span class="nt">ports</span><span class="p">:</span>
+        <span class="p p-Indicator">-</span> <span class="nt">containerPort</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">8000</span>
 </pre></div>
 </div>
 <p>There’s a lot of YAML here! But the idea is easy to summarize: schedule 1 server on Kubernetes.</p>

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -188,6 +188,7 @@ <h1 id="index">Index</h1>
  | <a href="#B"><strong>B</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#F"><strong>F</strong></a>
+ | <a href="#H"><strong>H</strong></a>
  | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#R"><strong>R</strong></a>
@@ -225,6 +226,14 @@ <h2 id="F">F</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.helm">helm() (in module api)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="K">K</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
@@ -2,5 +2,5 @@
 # Project: Tilt
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڍ�K��0���W�,�`�fW@�*�(Sb��ש�{�~=~4�S*�U�s�s��7E#��w��A�4�����YQ�a�$���2����7�4C�F��/�5ۓm�A*�@�.����ܿu�%��et;b��r�y��?WUz𛠶�>���k�%䭐����<��G
-��ߤ�9�\���Y5Lsj�h�x`���Y��}A�����psL�F;jQ��%����!;�(;�	�h���2!/��uO�Yb��^��t{��5�K�j2f�I-_�����O��F,>���,]�%����M<ȳ,=a��	��~Ð��T�}�s���E�<;�6��\�pK*Mj�X���	;�V����1HN�u���Y��UQ0OU�ŷ��n̸���\�&ʾ�e�y�h��5�t�ͧ���ebݟ�ѱ��Q=��s�j��淕��t;��ޘ��]Z~$~�[=��_��r
+xڍ�K��0����`1,���hv4�h��XE��ub��?Ą_�M딈t���׷-��;żD�o[��WYY�&�*j��G�J��ܞ���(�-���S��{!Y����c9Xw٢얘Ý�Z��k�:��y�T'�,�8����.�S�%� ����lb�c'��G�	�Rv�ݐ'�h��XQŰV���g��2za�A$���$V�ۥ���bR�P�����crBQr��k��#7눼�8<�=�c�=|��;9��= #_=�8[�3I�j.x�N�}C�4����U�h&�B��5ىN�A^d���O�h�������!l%y�~�![�~a�g��f��j$�QƢQ����:cǧD��n�x?y�0�ց�S:I��
+��ʹ��0s=�F#ǿ俒|.�`h;Md-û�o�����@ز閔ǜ'�UP����8W�M���Q�~ᰎ�S��ST�ع�G4��x����g��U