Docs
Launch GraphOS Studio

Cloud routing for supergraphs

Learn about Apollo-managed cloud routers


NOTE

Cloud are only available to organizations with and . They are not available with an or a legacy Free or Team plan.

See plan details.

When you create a cloud supergraph with , GraphOS automatically provisions and manages a router that acts as an entry point to your APIs. In this architecture, individual GraphQL APIs are called subgraphs. Clients send to your 's public endpoint, instead of sending them directly to your .

Your infrastructure
Apollo Cloud
Subgraph A
Subgraph B
Router
Clients

Initializing your router

Your is provisioned automatically whenever you create a cloud supergraph in GraphOS Studio, or whenever you create a new variant for an existing cloud . Each has its own distinct .

When you first create a , the provisioning process can take a few minutes. If this process hasn't completed yet for a particular variant, an INITIATING ENDPOINT label is shown at the top of the 's page in Studio:

Label in Studio indicating a router hasn't finished provisioning

Configuring your router

See Cloud router configuration.

Cloud launches

Publishing a new or editing a 's configuration triggers a new launch. Every automatically deploys new instances for your .

NOTE

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

Router version updates

With cloud routing, runs a fully managed fleet of for you. Apollo manages the version of Apollo Router that is deployed and ensures that newly released versions are deployed to within 30 days of release. Some minor and patch versions may be skipped.

releases go through rigorous testing before deployment on . During the deployment of new versions, an Apollo engineer actively oversees the process and rolls back any that fail to boot up. While some edge cases may arise—for example, a update could result in slightly degraded performance—router updates should not disrupt your .

NOTE

Opting out of updates to is currently not possible. Advanced version management will be available in Cloud Dedicated in 2024.

Automatic deletion of unused routers

NOTE

Only on the are automatically deleted. This does not apply cloud routers on the . See details about plans.

Apollo automatically deletes variants of Serverless cloud supergraphs that receive zero operations for 60 consecutive days. This deletes the , along with all the 's historical metrics.

  • Apollo will notify you via email whenever a is approaching this 60-day limit.
  • To prevent deletion, execute at least one on the 's before the 60-day limit.

Out of memory errors

You may receive out of memory errors when using on the Serverless plan. Since the offers limited underlying compute resources, Serverless cloud routing offers a fixed amount of throughput capacity.

Complex schemas may exceed available machine memory for . For example, Serverless cloud routers don't support schemas with over 1,000 input types. Additionally, complex queries that return too much data or too many simultaneously may fail.

You can upgrade to Cloud Dedicated for control over scaling and performance. Get in touch for a free trial.

Cloud routing FAQ

What happens if my cloud router goes down?

If your 's goes down, queries sent to it will fail until service is restored. However, every cloud router has redundant machines in place to help prevent this.

How is my data protected with cloud routing?

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

The (the underlying technology for cloud routing) has been tested and audited by Doyensec, with no issues.

How are cloud routers hosted?

Apollo works with major public cloud providers to deliver routing.

Which regions are available for cloud routers?

Cloud routing for is only available in Chicago, USA. Our infrastructure has interconnects with major public cloud providers, so latency is minimal. For example, latency between Chicago and AWS in Virginia is approximately 10 ms. If there's a specific region you'd like us to support please request a region.

Cloud routing on the has a wider variety of options. Get in touch to learn more.

Can I choose my cloud router's region?

Choice of region for is only available on the .

Does GraphOS also host my individual subgraphs?

No. only hosts the runtime for your 's . for your individual are still hosted in your infrastructure.

Which GraphQL server libraries are compatible with cloud routers?

Cloud use Apollo Federation 2 for their core architecture. Many GraphQL server libraries support Federation 2.

Your API does not already need to be using to add it to a cloud .

Next
Configuration
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company