diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index fc0ee67c3d..5c6e7cf0fa 100644 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -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 diff --git a/docs/source/containerization/kubernetes.mdx b/docs/source/containerization/kubernetes.mdx index 0244c98f7b..85459e96f7 100644 --- a/docs/source/containerization/kubernetes.mdx +++ b/docs/source/containerization/kubernetes.mdx @@ -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)