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.

Sign up for GitHub

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 kubernetes documentation to add helm OCI example #1457

Merged
merged 2 commits into from
Aug 3, 2022
Merged

update kubernetes documentation to add helm OCI example #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eecff2c
update kubernetes documentation to add helm OCI example
garypen Aug 3, 2022
244645a
Add a changelog
garypen Aug 3, 2022
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
6 changes: 6 additions & 0 deletions NEXT_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,9 @@ By [@bryncooke](https://github.com/bryncooke) in https://github.com/apollographq
## 🛠 Maintenance

## 📚 Documentation

### Add helm OCI example ([PR #1457](https://github.com/apollographql/router/pull/1457))

Update existing filesystem based example to illustrate how to do the same thing using our OCI stored helm chart.

By [@garypen](https://github.com/garypen) in https://github.com/apollographql/router/pull/1457
18 changes: 17 additions & 1 deletion docs/source/containerization/kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,27 @@ import { Link } from 'gatsby';

There is a complete [helm chart definition](https://github.com/apollographql/router/tree/main/helm/chart/router) in the repo which illustrates how to use helm to deploy the router in kubernetes.

Here's an example which would use helm to install the router:
In both the following examples, we are using helm to install the router:
- into namespace "router-deploy" (create namespace if it doesn't exist)
- with helm install name "router-test"
- with support for prometheus enabled

#### Using helm chart from our Open Container Initiative (OCI) registry

Starting with release 0.14.0, each time we release the router, we'll release
our helm chart and store it in the same OCI registry in which we store our
router docker images.

You can use helm to install charts from an OCI registry as follows:

```bash
helm install --set router.configuration.telemetry.metrics.prometheus.enabled=true --set managedFederation.apiKey="REDACTED" --set managedFederation.graphRef="REDACTED" --create-namespace --namespace router-deploy router-test oci://ghcr.io/apollographql/helm-charts/router --version 0.14.0 --values router/values.yaml
```

For more details about using helm with OCI based registries, see [here](https://helm.sh/docs/topics/registries/)

#### Using helm chart from your filesystem

You would run this command from "repo"/helm/chart directory.

(where "repo" is the directory containing your checked out router github repository)
Expand Down