Skip to content
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
5 changes: 5 additions & 0 deletions .changesets/docs_lambertjosh_readd_graph_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Add back the graph artifact documentation for the containers [PR #7752](hhttps://github.com/apollographql/router/pull/7752)

Adds back accidentally overwritten docs which occurred in PR 7734. The missing commit added graph artifact usage information.

By [lambertjosh](https://github.com/lambertjosh) in https://github.com/apollographql/router/pull/7752
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,11 @@

## Specifying the supergraph

If you don't want to automatically update your supergraph via [Apollo Uplink](/federation/managed-federation/uplink/), or you don't have connectivity to access Apollo Uplink from your environment, you can manually specify the details of your supergraph in a `docker run` command:
If you don't want to automatically update your supergraph via [Apollo Uplink](/federation/managed-federation/uplink/), or you don't have connectivity to access Apollo Uplink from your environment, you have two options:

Check warning on line 136 in docs/source/routing/self-hosted/containerization/docker-router-only.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker-router-only.mdx#L136

Avoid specifying the number of items when introducing a list. ```suggestion If you don't want to automatically update your supergraph via [Apollo Uplink](/federation/managed-federation/uplink/), or you don't have connectivity to access Apollo Uplink from your environment, you can use one of the following methods: ```

### Using a local supergraph file

Check warning on line 138 in docs/source/routing/self-hosted/containerization/docker-router-only.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker-router-only.mdx#L138

Headings in how-to articles should use the imperative mood. ```suggestion ### Use a local supergraph file ```

You can manually specify the details of your supergraph in a `docker run` command:

```bash
docker run -p 4000:4000 \
Expand All @@ -144,6 +148,20 @@

In this example, we have to mount the local definition of the supergraph into our image, _and_ specify the location of the file. It doesn't have to be mounted in the `/dist/schema` directory, but it's a reasonable location to use. We must specify the configuration file location as well, since overriding the default params will override our default config file location. In this case, since we don't want to change our router configuration but want to make sure it's used, we just specify the default location of the default configuration.

### Using an OCI image reference

Check warning on line 151 in docs/source/routing/self-hosted/containerization/docker-router-only.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker-router-only.mdx#L151

Headings in how-to articles should use the imperative mood. ```suggestion ### Use an OCI image reference ```

You can use the `--graph-artifact-reference` option to fetch the supergraph schema from an OCI image:

```bash
docker run -p 4000:4000 \
--env APOLLO_KEY="<your-graph-api-key>" \
--env GRAPH_ARTIFACT_REFERENCE="<your-oci-reference>" \
--rm \
ghcr.io/apollographql/router:<router-image-version>
```

When using this option, the router will fetch the schema from the specified OCI image instead of using Apollo Uplink.

Check warning on line 163 in docs/source/routing/self-hosted/containerization/docker-router-only.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker-router-only.mdx#L163

Use the present tense instead of the future tense to describe an action. ```suggestion When using this option, the router fetches the schema from the specified OCI image instead of using Apollo Uplink. ```

## Building your own container

<Note>
Expand Down
23 changes: 22 additions & 1 deletion docs/source/routing/self-hosted/containerization/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
--env APOLLO_KEY="<your-graph-api-key>" \
-v <<ABSOLUTE_PATH_TO_THE_MY_CONFIG_DIRECTORY>>:/config
--rm \
ghcr.io/apollographql/apollo-runtime:<router-image-version>
ghcr.io/apollographql/apollo-runtime:<runtime-image-version>
```

You can also mount specific files, for example the schema file, by specifying:
Expand All @@ -90,6 +90,27 @@

</Note>

## Specifying the supergraph

Check warning on line 93 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L93

Headings in how-to articles should use the imperative mood. ```suggestion ## Specify the supergraph ```

If you don't want to automatically update your supergraph via [Apollo Uplink](/federation/managed-federation/uplink/), or you don't have connectivity to access Apollo Uplink from your environment, you have two options:

Check warning on line 95 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L95

Avoid specifying the number of items when introducing a list. ```suggestion If you don't want to automatically update your supergraph via [Apollo Uplink](/federation/managed-federation/uplink/), or you don't have connectivity to access Apollo Uplink from your environment, you can use one of the following methods: ```

1. Using a local supergraph file, as documented in the [Configuring using local files](#configuring-using-local-files) section.

Check warning on line 97 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L97

Use an unordered list for options that are not sequential steps. List items should also use the imperative mood for consistency. ```suggestion - Use a local supergraph file, as documented in the [Configuring using local files](#configuring-using-local-files) section. ```
1. Using an [OCI image reference](#using-an-oci-image-reference)

Check warning on line 98 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L98

Use an unordered list for non-sequential options and ensure list items are structurally consistent with each other (imperative mood and ending punctuation). ```suggestion - Use an [OCI image reference](#using-an-oci-image-reference). ```

### Using an OCI image reference

Check warning on line 100 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L100

Headings in how-to articles should use the imperative mood. ```suggestion ### Use an OCI image reference ```

You can use the `GRAPH_ARTIFACT_REFERENCE` environment variable to fetch the supergraph schema from an OCI image:

```bash
docker run -p 4000:4000 \
--env APOLLO_KEY="<your-graph-api-key>" \
--env GRAPH_ARTIFACT_REFERENCE="<your-oci-reference>" \
--rm \
ghcr.io/apollographql/apollo-runtime:<runtime-image-version>
```

When using this option, the router will fetch the schema from the specified OCI image instead of using Apollo Uplink. Additional information on graph artifacts is available in the [router CLI options documentation](/docs/graphos/routing/configuration/cli#command-line-options).

Check warning on line 112 in docs/source/routing/self-hosted/containerization/docker.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/self-hosted/containerization/docker.mdx#L112

Use the present tense instead of the future tense. The lead-in to the link is also more direct. ```suggestion When using this option, the router fetches the schema from the specified OCI image instead of using Apollo Uplink. For more information on graph artifacts, see the [router CLI options documentation](/docs/graphos/routing/configuration/cli#command-line-options). ```

## Running a specific Router and MCP version

The container has a tagging scheme that consists of three parts, the container version, the Apollo Router version, and the MCP Server version, each separated by underscores.
Expand Down