Skip to content

Add note to docs about Apollo GraphOS Operator #8670

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

Merged
merged 5 commits into from
Dec 1, 2025
+32 −12
Merged

Add note to docs about Apollo GraphOS Operator #8670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
559dab3
Add note to docs about Apollo GraphOS Operator
DMallare Nov 24, 2025
da2a265
Removed preview message
DMallare Nov 25, 2025
f9cf598
Adds operator section to deployment overview
DMallare Nov 25, 2025
6513c90
Minor style fixes
DMallare Nov 25, 2025
e61a2d5
Addresses comments
DMallare Nov 29, 2025
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
31 changes: 20 additions & 11 deletions docs/source/routing/self-hosted/containerization/kubernetes/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,31 @@
import HelmShowOutput from '../../../../../shared/helm-show-router-output.mdx';
import CoprocTypicalConfig from '../../../../../shared/coproc-typical-config.mdx';

<Note>

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.

Check notice on line 14 in docs/source/routing/self-hosted/containerization/kubernetes/quickstart.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

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

Improves parallel structure in the first sentence ('for X and for Y') and splits the second sentence to improve readability and use active voice ('This simplifies...').

```suggestion
Apollo recommends using the [Apollo GraphOS Operator](/apollo-operator/) for production deployments and for managing multiple routers or complex architectures. The Operator provides declarative Kubernetes resources to manage routers, supergraphs, graph schemas, and subgraphs. This simplifies maintaining consistency and automating deployments across your infrastructure.
```

<br/><br/>

Use the Operator when you need:
- Production-grade deployments with declarative configuration management
- Simplified management of multiple routers, supergraphs, and subgraphs
- Support for complex architectures including single-cluster, multi-cluster, and hybrid configurations
- Integration with existing CI/CD workflows through deploy-only patterns

For more details, see the [Operator workflow patterns](/apollo-operator/workflows/).

</Note>

<ElasticNotice />

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.

Check warning on line 30 in docs/source/routing/self-hosted/containerization/kubernetes/quickstart.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

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

Uses the imperative mood for the opening instruction and ensures parallel structure in the list of use cases by removing the clause 'when you prefer'.

```suggestion
Deploy a self-hosted router in Kubernetes using Helm charts. Helm is suitable for quick deployments, testing, or direct Helm chart management.
```

This guide shows how to:

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

<ElasticNotice />

## Prerequisites

<Note>
Expand Down Expand Up @@ -124,12 +142,3 @@
```bash
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
```

## Consider using the Apollo GraphOS Operator

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.

The Operator offers different [workflow patterns](/apollo-operator/workflows/) depending on your infrastructure:
- Single-cluster setups for simpler deployments
- Multi-cluster and hybrid configurations for distributed services
- Deploy-only patterns for existing CI/CD workflows
13 changes: 12 additions & 1 deletion docs/source/routing/self-hosted/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,18 @@ For each version of the Apollo Router, Apollo provides:
- [A Docker image](#container)
- [A binary](#local-binary)

## Kubernetes using Helm
## Kubernetes

### Apollo GraphOS Operator

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.

The Operator supports [workflow patterns](/apollo-operator/workflows/) based on your infrastructure:
- Single-cluster setups for simpler deployments
- Multi-cluster and hybrid configurations for distributed services
- Deploy-only patterns for existing CI/CD workflows

### Helm

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`.

Expand Down