Skip to content

Commit

Permalink
docs(strm-2485): improve helm chart install and upgrade docs (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-p92 committed Jun 21, 2023
1 parent 1fc6bf4 commit 50247e4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 18 deletions.
3 changes: 2 additions & 1 deletion docs/03-quickstart/05-ccd/02-self-hosted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ helm install strmprivacy strmrepo/strm --values values.yaml --namespace strmpriv
</TabItem>
<TabItem value="github-chart" label="Directly from GitHub">

Alternatively, clone the Helm Chart's [GitHub repo][github-chart] and checkout the master branch.
Alternatively, clone the Helm Chart's [GitHub repo][github-chart] and checkout the [latest release](https://github.com/strmprivacy/data-plane-helm-chart/releases), e.g.
`git checkout tags/<tag> -b latest`.

From the repo's root, and assuming your `values.yaml` file is in the root as well, execute the following
to install _all_ the STRM components inside the `strmprivacy` namespace (or a different one of your choice).
Expand Down
28 changes: 11 additions & 17 deletions docs/03-quickstart/05-ccd/99-updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,43 +71,37 @@ versions < 1.16.0, the `appVersion` differs from the `version`.

### Upgrade the Helm Chart

Next, make sure you are able to access the Helm Chart Repository and do the upgrade. This depends on which installation
mode you have chosen:
The upgrade procedure depends on the type of installation you have chosen (self-hosted or AWS Marketplace).

:::danger
Omitting the `--version` flag in the `helm upgrade` command results in Helm upgrading to the **latest** version.
Be cautious, as this may include major version upgrades. Consult the [migration guides](#migration-guides) first.
Be cautious, as this may include major version upgrades. Consult the [migration guides](#migration-guides) first
for any breaking changes.
:::

<Tabs>
<TabItem value="self-hosted" label="Self-Hosted Installation">

Ensure you have installed the GCS (Google Cloud Storage is where we host our Helm Chart Repository) plugin for Helm:
First, make sure you are able to access the Helm Chart Repository, either through the Helm GCS Plugin or directly from
our GitHub repo (see [here](docs/03-quickstart/05-ccd/02-self-hosted/index.md#step-2-install-the-helm-chart)).

```bash
helm plugin install https://github.com/hayorov/helm-gcs.git
```
If you installed the Helm chart directly from our GitHub repo, make sure you checkout the latest release tag again,
and use the same command as during installation, but replace `install` by `upgrade`.

Add the Helm Repo if it's not added yet:

```bash
helm repo add strmrepo gs://stream-machine-production-helm-chart/data-plane
```

Or update the repo if it was already added:
If you have installed the GCS Helm plugin, update the STRM Repo first like so:

```bash
helm repo update
```

Next, upgrade the deployed Helm Chart (assuming that your chart is named `strmprivacy-data-plane`):
Then, upgrade the deployed Helm Chart (assuming that your chart is named `strmprivacy-data-plane`):

```bash
helm upgrade strmprivacy-data-plane --namespace strmprivacy strmrepo/strm --values values.yaml
```

Either use a `values.yaml` file (a pre-populated version can be downloaded from the Console, in
your [installation page](https://console.strmprivacy.io)), or use the `--set` option to set individual properties.
In both cases, either use a `values.yaml` file (a pre-populated version can be downloaded from the Console, in
your [installation page](https://console.strmprivacy.io/settings/installation)), or use the `--set` option to set individual properties.

</TabItem>

Expand Down

0 comments on commit 50247e4

Please sign in to comment.