Skip to content

Commit

Permalink
Update Helm chart installation commands
Browse files Browse the repository at this point in the history
  • Loading branch information
drivard committed Dec 15, 2023
1 parent 594ee56 commit 9b52720
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ helm search repo libretranslate
To install the chart with the release name `libretranslate`:

```bash
helm install libretranslate libretranslate --namespace libretranslate --create-namespace
helm install libretranslate libretranslate/libretranslate --namespace libretranslate --create-namespace
```

This command deploys LibreTranslate on the Kubernetes cluster with the default configuration. The [values.yaml](charts/libretranslate/values.yaml) file lists the parameters that can be configured during installation.
Expand All @@ -43,21 +43,21 @@ These commands remove all the Kubernetes components associated with the chart an
See [values.yaml](charts/libretranslate/values.yaml) for the full list of parameters that can be configured. You can specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```bash
helm install libretranslate libretranslate --namespace libretranslate --create-namespace --set service.port=8080
helm install libretranslate libretranslate/libretranslate --namespace libretranslate --create-namespace --set service.port=8080
```

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

```bash
helm install libretranslate libretranslate --namespace libretranslate --create-namespace -f values.yaml
helm install libretranslate libretranslate/libretranslate --namespace libretranslate --create-namespace -f values.yaml
```

## Upgrade

Run the following command to upgrade your LibreTranslate installation. This command will use the Helm chart, apply the custom values from values.yaml, and deploy the upgrade to the `libretranslate` namespace:

```bash
helm upgrade --install libretranslate libretranslate --namespace libretranslate -f values.yaml
helm upgrade --install libretranslate libretranslate/libretranslate --namespace libretranslate -f values.yaml
```

> **Tip**: You can use the default [values.yaml](charts/libretranslate/values.yaml)
Expand Down
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2 id="installing-the-chart">Installing the Chart</h2>
</p>
<div class="sourceCode" id="cb2">
<pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span></span></code></pre>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate/libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span></span></code></pre>
</div>
<p>This command deploys LibreTranslate on the Kubernetes cluster with
the default configuration. The <a href="charts/libretranslate/values.yaml">values.yaml</a> file lists the
Expand All @@ -71,13 +71,13 @@ <h2 id="configuration">Configuration</h2>
</p>
<div class="sourceCode" id="cb4">
<pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span> <span class="at">--set</span> service.port=8080</span></code></pre>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate/libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span> <span class="at">--set</span> service.port=8080</span></code></pre>
</div>
<p>Alternatively, a YAML file that specifies the values for the
parameters can be provided while installing the chart. For example,</p>
<div class="sourceCode" id="cb5">
<pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span> <span class="at">-f</span> values.yaml</span></code></pre>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> install libretranslate libretranslate/libretranslate <span class="at">--namespace</span> libretranslate <span class="at">--create-namespace</span> <span class="at">-f</span> values.yaml</span></code></pre>
</div>
<h2 id="upgrade">Upgrade</h2>
<p>Run the following command to upgrade your LibreTranslate
Expand All @@ -87,7 +87,7 @@ <h2 id="upgrade">Upgrade</h2>
</p>
<div class="sourceCode" id="cb6">
<pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> upgrade <span class="at">--install</span> libretranslate libretranslate <span class="at">--namespace</span> libretranslate <span class="at">-f</span> values.yaml</span></code></pre>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">helm</span> upgrade <span class="at">--install</span> libretranslate libretranslate/libretranslate <span class="at">--namespace</span> libretranslate <span class="at">-f</span> values.yaml</span></code></pre>
</div>
<blockquote>
<p><strong>Tip</strong>: You can use the default <a href="charts/libretranslate/values.yaml">values.yaml</a></p>
Expand Down

0 comments on commit 9b52720

Please sign in to comment.