Skip to content

Commit f013b0d

Browse files
authored
Add note to docs about Apollo GraphOS Operator (#8670)
1 parent 161e6e9 commit f013b0d

File tree

2 files changed

+32
-12
lines changed

2 files changed

+32
-12
lines changed

docs/source/routing/self-hosted/containerization/kubernetes/quickstart.mdx

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,31 @@ redirectFrom:
99
import HelmShowOutput from '../../../../../shared/helm-show-router-output.mdx';
1010
import CoprocTypicalConfig from '../../../../../shared/coproc-typical-config.mdx';
1111

12+
<Note>
13+
14+
Apollo recommends using the [Apollo GraphOS Operator](/apollo-operator/) for production deployments and when managing multiple routers or complex architectures. The Operator provides declarative Kubernetes resources to manage routers, supergraphs, graph schemas, and subgraphs, making it easier to maintain consistency and automate deployments across your infrastructure.
15+
16+
<br/><br/>
17+
18+
Use the Operator when you need:
19+
- Production-grade deployments with declarative configuration management
20+
- Simplified management of multiple routers, supergraphs, and subgraphs
21+
- Support for complex architectures including single-cluster, multi-cluster, and hybrid configurations
22+
- Integration with existing CI/CD workflows through deploy-only patterns
23+
24+
For more details, see the [Operator workflow patterns](/apollo-operator/workflows/).
25+
26+
</Note>
27+
28+
<ElasticNotice />
29+
30+
This guide uses Helm charts to deploy a self-hosted router in Kubernetes. Using Helm is suitable for quick deployments, testing, or when you prefer direct Helm chart management.
31+
1232
This guide shows how to:
1333

1434
* Get the router Helm chart from the Apollo container repository.
1535
* Deploy a router with a basic Helm chart.
1636

17-
<ElasticNotice />
18-
1937
## Prerequisites
2038

2139
<Note>
@@ -124,12 +142,3 @@ For example, this command deploys with a `common_values.yaml` file applied first
124142
```bash
125143
helm install <name_for_install> --namespace <router-namespace> --set managedFederation.apiKey="<graph-api-key>" --set managedFederation.graphRef="<graph-ref>" oci://ghcr.io/apollographql/helm-charts/router --version <router-version> --values router/values.yaml --values common_values.yaml --values prod_values.yaml
126144
```
127-
128-
## Consider using the Apollo GraphOS Operator
129-
130-
The [Apollo GraphOS Operator](/apollo-operator/), which is in Preview, offers an alternative method to deploy the router and manage your schema and subgraphs. The Operator provides declarative Kubernetes resources for managing routers, supergraphs, graph schemas, and subgraphs. It can simplify complex multi-service architectures.
131-
132-
The Operator offers different [workflow patterns](/apollo-operator/workflows/) depending on your infrastructure:
133-
- Single-cluster setups for simpler deployments
134-
- Multi-cluster and hybrid configurations for distributed services
135-
- Deploy-only patterns for existing CI/CD workflows

docs/source/routing/self-hosted/index.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,18 @@ For each version of the Apollo Router, Apollo provides:
2424
- [A Docker image](#container)
2525
- [A binary](#local-binary)
2626

27-
## Kubernetes using Helm
27+
## Kubernetes
28+
29+
### Apollo GraphOS Operator
30+
31+
Apollo recommends the [Apollo GraphOS Operator](/apollo-operator/). The Operator provides declarative Kubernetes resources to manage routers, supergraphs, graph schemas, and subgraphs. It simplifies complex multi-service architectures.
32+
33+
The Operator supports [workflow patterns](/apollo-operator/workflows/) based on your infrastructure:
34+
- Single-cluster setups for simpler deployments
35+
- Multi-cluster and hybrid configurations for distributed services
36+
- Deploy-only patterns for existing CI/CD workflows
37+
38+
### Helm
2839

2940
Helm is a package manager for Kubernetes. Apollo provides a Helm chart with each release of Apollo Router in the GitHub Container Registry. Since router v0.14.0, Apollo has released each router Helm chart as an Open Container Initiative (OCI) image in `oci://ghcr.io/apollographql/helm-charts/router`.
3041

0 commit comments

Comments
 (0)