Rover supergraph commands
For use with Apollo Federation
A supergraph (also called a federated graph) is a graph composed of multiple subgraphs:
Rover commands that interact with supergraphs begin with
rover supergraph. These commands primarily deal with supergraph schemas.
This command requires authenticating Rover with Apollo Studio.
You can use Rover to fetch the supergraph schema of any federated Studio graph variant it has access to. Run the
supergraph fetch command, like so:
rover supergraph fetch my-supergraph@my-variant
my-supergraph@my-variant in the example above specifies the ID of the Studio graph you're fetching from, along with which variant you're fetching.
You can omit
@ and the variant name. If you do, Rover uses the default variant, named
rover supergraph compose --config ./supergraph.yaml
You can also pass config via stdin:
cat ./supergraph.yaml | rover supergraph compose --config -
The supergraph configuration file (often referred to as
supergraph.yaml) includes configuration options for each of your subgraphs. The following example file configures a supergraph with two subgraphs (
federation_version: 2subgraphs:films:routing_url: https://films.example.comschema:file: ./films.graphqlpeople:routing_url: https://people.example.comschema:file: ./people.graphql
In the above example, The YAML file specifies each subgraph's public-facing URL (
routing_url), along with the path to its schema (
A single configuration file can pull subgraph schemas from a variety of sources. For example, here's a configuration that includes subgraph schemas from three different types of sources:
federation_version: 2subgraphs:# Local .graphql filefilms:routing_url: https://films.example.comschema:file: ./films.graphql# Subgraph introspectionpeople:routing_url: https://example.com/peopleschema:subgraph_url: https://example.com/people# Apollo Studio graph refactors:routing_url: https://localhost:4005schema:graphref: mygraph@currentsubgraph: actors
⚠️ Your gateway fails to start up if you provide it with a supergraph schema that it doesn't support! To ensure compatibility, we recommend that you always test launching your gateway in a CI pipeline with the supergraph schema it will ultimately use in production.
You can save the schema output to a local
.graphql file like so:
# Creates prod-schema.graphql or overwrites if it already existsrover supergraph compose --config ./supergraph.yaml > prod-schema.graphql
For more on passing values via
stdout, see Using
The first time you use Federation 2 composition on a particular machine, Rover prompts you to accept the terms and conditions of the ELv2 license. On future invocations, Rover remembers that you already accepted the license and doesn't prompt you again (even if you update Rover).
⚠️ Important: CI systems wipe away any persisted Rover configuration on each run, and they can't accept the interactive ELv2 prompt. To automatically accept the prompt in CI, do any of the following:
- Set the environment variable
APOLLO_ELV2_LICENSE=acceptin your CI environment.
--elv2-license acceptin your
rover supergraph composecommand.
yes | rover supergraph compose
supergraph plugin (built from this source) is installed to
~/.rover/bin if you installed with the
curl | sh installer, and to
./node_modules/.bin/ if you installed with npm.
supergraph compose command supports both Federation 2 and Federation 1 composition. It determines which version to use according to the following logic:
A subgraph schema "opts in" to Federation 2 by adding a special
@link directive described in this article.
Here's an example
supergraph.yaml file that specifies Federation 1 composition:
federation_version: 1subgraphs:films:routing_url: https://films.example.comschema:file: ./films.graphql
⚠️ Note that if you use Federation 1 composition and any of your subgraphs uses a Federation 2 schema, composition will fail!
Federation 1 and Federation 2 use different composition algorithms, which are implemented in different libraries:
Whenever you run
rover supergraph compose, Rover automatically downloads the latest version of the library for your selected composition version (if there's an update).
Any updates to a given composition version should always be backward compatible. If composition unexpectedly breaks following an update, please submit an issue and see Pinning composition to a library version.
In some cases, you might want Rover to skip updating its composition library to the latest version. For example, you might have a slow or nonexistent network connection.
In these cases, you can pass the
--skip-update flag to
rover supergraph compose. If you provide this flag, your
supergraph.yaml file must specify a
⚠️ You should do this only if composition unexpectedly breaks between calls to
rover supergraph compose as an attempt to debug the issue.
You can pin your composition algorithm to a particular version of its library via the
federation_version key in your
In the above example, Rover uses exactly version
2.0.1 of the
@apollo/composition library for Federation 2 composition.
Versions of Rover prior to v0.5.0 support only Federation 1 composition, via the
We recommend updating to the latest version of Rover as soon as possible. If you're still using a legacy version, see the following compatibility table regarding support for different versions of the
|Rover version||Gateway version|
|<= v0.2.x||<= v0.38.x|
|>= v0.3.x||>= v0.39.x|