Join us from October 8-10 in New York City to learn the latest tips, trends, and news about GraphQL federation and API platform engineering.Join us for GraphQL Summit 2024 in NYC
Docs
Start for Free

Cloud routing for supergraphs

Learn about Apollo-managed cloud routers


When you create a cloud , provisions and manages a cloud router. act as entry points to your APIs. Individual GraphQL APIs are called subgraphs in this architecture.

Your infrastructure
GraphOS Cloud
Subgraph A
Subgraph B
Cloud router
Clients

Clients send to your 's public endpoint instead of your .

GraphOS only hosts the runtime for your supergraph's . for your subgraphs are still hosted in your infrastructure.

Create your first cloud supergraph

Federation and subgraph compatibility

Cloud use Apollo Federation 2 for their core architecture. Many GraphQL server libraries support Federation 2. Your GraphQL API doesn't already need to be using to add it to a cloud supergraph.

Cloud router types and availability

Cloud supergraphs are only available to organizations with and . They aren't available with Enterprise or legacy Free or Team plans.

Serverless run on shared infrastructure. cloud routers run on dedicated infrastructure that you control and scale. See the pricing page for more information.

Cloud router regions

Serverless cloud routers are hosted in the us-east-1 AWS region. Dedicated cloud routers have a wider variety of options. Region selection for cloud routers is only available on the . Contact Sales to learn more. You can view a cloud router's region on its 's Overview page under Cloud Router Details.

Variant overview page in GraphOS Studio

⚠️ CAUTION

Some legacy Serverless cloud routers are hosted in Chicago, Illinois. If your cloud router is hosted in Chicago, you need to migrate by June 27, 2024.

Cloud router status

can have the following statuses:

StatusDescription
InitializingYour cloud router is being created. This process may take up to five minutes. Learn more.
RunningYour graph is operating normally.
ErrorYour cloud router is running, but a deployment recently failed. For more information on the failure, see the Launches page in GraphOS Studio.

NOTE

Serverless have additional statuses, including Sleeping and Deleted. Learn more on the Serverless overview page.

You can see your cloud router's status in on the associated graph's Overview page under Cloud Router Details.

Initializing

Apollo provisions a router whenever you create a cloud supergraph in GraphOS Studio or whenever you create a new for an existing cloud supergraph. Each variant has its own distinct router.

When you first create a variant, the router provisioning process can take a few minutes. While this process completes, an INITIATING ENDPOINT label appears at the top of the variant's page in Studio:

Label in Studio indicating a router hasn't finished provisioning

Once initialized, you can configure your cloud router.

Cloud launches

Publishing a new or editing a cloud router's config triggers a new launch. Every automatically deploys new router instances for your graph. You can see a launch's details, including possible failures, from a graph's Launches page in GraphOS Studio.

NOTE

A router deployment might fail due to a platform incident or schema issues. To resolve this, try republishing your subgraph schema.

Router version updates

Apollo manages the version of deployed to cloud routers. It ensures that newly released versions are deployed within 30 days of release. Some minor and patch versions may be skipped.

releases go through rigorous testing before deployment on . An Apollo engineer oversees deployment. If any cloud routers fail to boot up, they roll back to a previous version. While some edge cases may arise—for example, a update could result in slightly degraded performance—router updates should not disrupt your supergraphs.

NOTE

Opting out of router updates to cloud routers isn't currently supported. Advanced version management will be available in Dedicated in 2024.

Security and compliance

The entire GraphOS platform, including its cloud routing infrastructure, is SOC 2 Type 2 certified. Secrets are encrypted both in transit and at rest. Secrets are only available inside the runtime environment. You have total control over when those secrets are resolved in configuration.

The Apollo Router (the underlying technology for cloud routing) has been tested and audited by Doyensec.

GraphOS Cloud on AWS

GraphOS Cloud on AWS is a managed API solution. It runs the Apollo Router on AWS infrastructure to provide a high-performance, configurable GraphQL router.

Download an overview of GraphOS Cloud on AWS security and compliance practices. For more information on Apollo's compliance and security measures, visit the Trust Center.

Next
Configuration
Rate articleRateEdit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company