Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update our helm documentation to illustrate how to use our registry #1649

Merged
merged 3 commits into from
Aug 30, 2022
Merged
Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions NEXT_CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ By [@USERNAME](https://github.com/USERNAME) in https://github.com/apollographql/
## ❗ BREAKING ❗
## 🚀 Features
## 🐛 Fixes

### Update our helm documentation to illustrate how to use our registry ([PR #1649](https://github.com/apollographql/router/issues/1649))

The helm chart never used to have a registry, so our docs were really just placeholders. I've updated them to reflect the fact that we now store the chart in our OCI registry.

By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/1649

## 🛠 Maintenance

### Remove cache layer ([PR #1647](https://github.com/apollographql/router/issues/1647))
Expand Down
5 changes: 2 additions & 3 deletions helm/chart/router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,15 @@
## Get Repo Info

```console
helm repo add apollographql https://todo/where-to-host-helm-repo
helm repo update
helm pull oci://ghcr.io/apollographql/helm-charts/router --version 0.1.21
```

## Install Chart

**Important:** only helm3 is supported

```console
helm upgrade --install [RELEASE_NAME] apollographql/router --values my-values.yaml
helm upgrade --install [RELEASE_NAME] oci://ghcr.io/apollographql/helm-charts/router --version 0.1.21 --values my-values.yaml
```

_See [configuration](#configuration) below._
Expand Down
5 changes: 2 additions & 3 deletions helm/chart/router/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@
## Get Repo Info

```console
helm repo add apollographql https://todo/where-to-host-helm-repo
helm repo update
helm pull oci://ghcr.io/apollographql/helm-charts/router --version {{ template "chart.version" . }}
```

## Install Chart

**Important:** only helm3 is supported

```console
helm upgrade --install [RELEASE_NAME] apollographql/router --values my-values.yaml
helm upgrade --install [RELEASE_NAME] oci://ghcr.io/apollographql/helm-charts/router --version {{ template "chart.version" . }} --values my-values.yaml
```

_See [configuration](#configuration) below._
Expand Down