Serverless Plugin Apollo GraphQL Federation

A Serverless Framework that uploads a graphql schema to the Apollo Platform managed federation service

View on Github

Serverless Plugin Apollo Graphql Federation

A serverless plugin that uploads graphql schemas to Apollo managed federation. This plugin should be used in implementing services. This allows the gateway service to pull schema from apollo managed federation and also stops implementing services from uploading invalid schemas that would cause the gateway to fail.


Install with npm

npm i -D serverless-plugin-apollo-graphql-federation

Add to serverless.yml

  - serverless-plugin-apollo-graphql-federation
      uploadForDeploymentRegion: eu-west-2
        - name: 'myGraph'
          apolloKey: apollo-api-key-for-my-graph
          url: https://my-implementing-service/mygraphendpoint
          schema: './myGraph/schema.gql',

Deploy using sls deploy --region xxx or sls apollo service:push

uploadForDeploymentRegion (optional) is used for multi-region deployments where the same api is deployed to multiple AWS regions. If you encounter intermittent Apollo schema validation failures when doing simultaneous regional deployments, try setting this variable to one of your deployment regions. The schema only needs to be uploaded for a single region.

Couldn't I just use the serverless-hooks-plugin to do this?

Yes you could but this would potentially log your apolloKey in your build server logs which is undesirable.