Skip to content

Commit

Permalink
chore: regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dokku Bot committed Dec 3, 2024
1 parent 6bd2341 commit 6b5497e
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions docs/deployment/schedulers/k3s/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3298,6 +3298,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#customizing-helm-chart-properties" class="md-nav__link">
<span class="md-ellipsis">
Customizing Helm Chart Properties
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -4181,6 +4190,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#customizing-helm-chart-properties" class="md-nav__link">
<span class="md-ellipsis">
Customizing Helm Chart Properties
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -4660,6 +4678,23 @@ <h3 id="customizing-the-kubernetes-context">Customizing the Kubernetes context<a
<div class="highlight"><pre><span></span><code><a id="__codelineno-56-1" name="__codelineno-56-1" href="#__codelineno-56-1"></a>dokku<span class="w"> </span>scheduler-k3s:set<span class="w"> </span>--global<span class="w"> </span>kube-context
</code></pre></div>
<p>The default value for the <code>kube-context</code> is an empty string, and will result in Dokku using the current context within the kubeconfig.</p>
<h3 id="customizing-helm-chart-properties">Customizing Helm Chart Properties<a class="headerlink" href="#customizing-helm-chart-properties" title="Permanent link">&para;</a></h3>
<p>Dokku includes a number of helm charts by default with settings that are optimized for Dokku. That said, it may be useful to further customize the charts for a given environment. Users can customize which charts are installed by setting properties prefixed with <code>chart.$CHART_NAME.</code> with the <code>--global</code> flag.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-57-1" name="__codelineno-57-1" href="#__codelineno-57-1"></a>dokku<span class="w"> </span>scheduler-k3s:set<span class="w"> </span>--global<span class="w"> </span>chart.cert-manager.version<span class="w"> </span><span class="m">1</span>.13.3
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Properties follow dot-notation, and are expanded according to Helm's internal logic. See the <a href="https://helm.sh/docs/helm/helm_install/#helm-install">Helm documentation</a> for <code>helm install</code> for further details.</p>
</div>
<p>To unset a chart property, omit the value from the <code>scheduler-k3s:set</code> call:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-58-1" name="__codelineno-58-1" href="#__codelineno-58-1"></a>dokku<span class="w"> </span>scheduler-k3s:set<span class="w"> </span>--global<span class="w"> </span>chart.cert-manager.version
</code></pre></div>
<p>A <code>scheduler-k3s:ensure-charts</code> command with the <code>--force</code> flag is required after changing any chart properties in order to have them apply. This will install all charts, not just the ones that have changed.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-59-1" name="__codelineno-59-1" href="#__codelineno-59-1"></a>dokku<span class="w"> </span>scheduler-k3s:ensure-charts<span class="w"> </span>--force
</code></pre></div>
<p>Alternatively, a comma separated list of chart names can be specified to only force install the specified charts:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-60-1" name="__codelineno-60-1" href="#__codelineno-60-1"></a>dokku<span class="w"> </span>scheduler-k3s:ensure-charts<span class="w"> </span>--force<span class="w"> </span>--chart-names<span class="w"> </span>cert-manager
</code></pre></div>
<h2 id="scheduler-interface">Scheduler Interface<a class="headerlink" href="#scheduler-interface" title="Permanent link">&para;</a></h2>
<p>The following sections describe implemented and unimplemented scheduler functionality for the <code>k3s</code> scheduler.</p>
<h3 id="implemented-commands-and-triggers">Implemented Commands and Triggers<a class="headerlink" href="#implemented-commands-and-triggers" title="Permanent link">&para;</a></h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 6b5497e

Please sign in to comment.