Skip to content
This repository was archived by the owner on Jun 6, 2019. It is now read-only.

Clarify helm documentation, keel and tiller must share namespace #3

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion v1/guide/documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ <h3 id="DaemonSet-polling-example"><a href="#DaemonSet-polling-example" class="h
<figure class="highlight yaml"><table><tr><td class="code"><pre><span class="line"><span class="attr">apiVersion:</span> <span class="string">apps/v1</span></span><br><span class="line"><span class="attr">kind:</span> <span class="string">DaemonSet</span></span><br><span class="line"><span class="attr">metadata:</span></span><br><span class="line"><span class="attr"> name:</span> <span class="string">wd-ds</span></span><br><span class="line"><span class="attr"> namespace:</span> <span class="string">default</span></span><br><span class="line"><span class="attr"> labels:</span> </span><br><span class="line"><span class="attr"> name:</span> <span class="string">"wd"</span></span><br><span class="line"> <span class="string">keel.sh/policy:</span> <span class="string">minor</span></span><br><span class="line"> <span class="string">keel.sh/trigger:</span> <span class="string">poll</span> </span><br><span class="line"><span class="attr"> annotations:</span></span><br><span class="line"> <span class="string">keel.sh/pollSchedule:</span> <span class="string">"@every 1m"</span> </span><br><span class="line"><span class="attr">spec:</span></span><br><span class="line"><span class="attr"> selector:</span></span><br><span class="line"><span class="attr"> matchLabels:</span></span><br><span class="line"><span class="attr"> name:</span> <span class="string">wd-ds</span></span><br><span class="line"><span class="attr"> template:</span></span><br><span class="line"><span class="attr"> metadata:</span></span><br><span class="line"><span class="attr"> labels:</span></span><br><span class="line"><span class="attr"> name:</span> <span class="string">wd-ds</span></span><br><span class="line"><span class="attr"> spec:</span> </span><br><span class="line"><span class="attr"> containers:</span></span><br><span class="line"><span class="attr"> - name:</span> <span class="string">wd-ds</span></span><br><span class="line"><span class="attr"> image:</span> <span class="string">karolisr/webhook-demo:0.0.8</span></span><br><span class="line"><span class="attr"> imagePullPolicy:</span> <span class="string">Always</span> </span><br><span class="line"><span class="attr"> name:</span> <span class="string">wd</span></span><br><span class="line"><span class="attr"> command:</span> <span class="string">["/bin/webhook-demo"]</span></span><br><span class="line"><span class="attr"> ports:</span></span><br><span class="line"><span class="attr"> - containerPort:</span> <span class="number">8090</span> </span><br><span class="line"><span class="attr"> livenessProbe:</span></span><br><span class="line"><span class="attr"> httpGet:</span></span><br><span class="line"><span class="attr"> path:</span> <span class="string">/healthz</span></span><br><span class="line"><span class="attr"> port:</span> <span class="number">8090</span></span><br><span class="line"><span class="attr"> initialDelaySeconds:</span> <span class="number">30</span></span><br><span class="line"><span class="attr"> timeoutSeconds:</span> <span class="number">10</span></span><br><span class="line"><span class="attr"> securityContext:</span></span><br><span class="line"><span class="attr"> privileged:</span> <span class="literal">true</span></span><br></pre></td></tr></table></figure>
<h3 id="Helm"><a href="#Helm" class="headerlink" title="Helm"></a>Helm</h3><p>Helm helps you manage Kubernetes applications — Helm Charts helps you define, install, and upgrade even the most complex Kubernetes application. More information can be found on project’s website <a href="https://helm.sh/" target="_blank" rel="noopener">https://helm.sh/</a>. </p>
<p>Keel works directly with Tiller (a daemon that is used by Helm CLI) to manage release upgrades when new images are available. </p>
<blockquote><p><strong>Note</strong>: Keel must be installed into the same namespace as Tiller, typically <code>kube-system</code></p></blockquote>
<h3 id="Helm-example"><a href="#Helm-example" class="headerlink" title="Helm example"></a>Helm example</h3><p>Keel is configured through your chart’s <code>values.yaml</code> file.</p>
<p>Here is an example application <code>values.yaml</code> file where we instruct Keel to track and update specific values whenever there is a new version:</p>
<figure class="highlight yaml"><table><tr><td class="code"><pre><span class="line"><span class="attr">replicaCount:</span> <span class="number">1</span></span><br><span class="line"><span class="attr">image:</span></span><br><span class="line"><span class="attr"> repository:</span> <span class="string">karolisr/webhook-demo</span></span><br><span class="line"><span class="attr"> tag:</span> <span class="string">"0.0.8"</span></span><br><span class="line"><span class="attr"> pullPolicy:</span> <span class="string">IfNotPresent</span></span><br><span class="line"><span class="attr">service:</span></span><br><span class="line"><span class="attr"> name:</span> <span class="string">webhookdemo</span></span><br><span class="line"><span class="attr"> type:</span> <span class="string">ClusterIP</span></span><br><span class="line"><span class="attr"> externalPort:</span> <span class="number">8090</span></span><br><span class="line"><span class="attr"> internalPort:</span> <span class="number">8090</span></span><br><span class="line"></span><br><span class="line"><span class="attr">keel:</span></span><br><span class="line"> <span class="comment"># keel policy (all/major/minor/patch/force)</span></span><br><span class="line"><span class="attr"> policy:</span> <span class="string">all</span></span><br><span class="line"> <span class="comment"># images to track and update</span></span><br><span class="line"><span class="attr"> images:</span></span><br><span class="line"><span class="attr"> - repository:</span> <span class="string">image.repository</span> <span class="comment"># [1]</span></span><br><span class="line"><span class="attr"> tag:</span> <span class="string">image.tag</span> <span class="comment"># [2]</span></span><br></pre></td></tr></table></figure>
Expand Down Expand Up @@ -607,4 +608,4 @@ <h3 id="Overriding-default-channels-per-deployment"><a href="#Overriding-default
</script>
</body>

</html>
</html>