Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 6.12 KB

README.md

File metadata and controls

59 lines (37 loc) · 6.12 KB
Raw

AWS Game Backend Framework Sample Backend Components

These sample components can be deployed to test integration from a game client to a backend using the authentication feature of the custom identity component.

IMPORTANT NOTE: The sample components don't use a custom domain to route traffic, but rather the default endpoints provided by Amazon API Gateway and Application Load Balancer. The recommendation is to use Amazon Route53 to create your own domain, and route subdomains to the individual public backend endpoints. This way you can use TLS certificates created for your domain to validate your endpoints, and have control over changing the endpoints as needed without modifying your client. In addition, the sample Fargate backend API uses HTTP instead of HTTPS because we are not configuring access through your own domain. You should configure a TLS certificate for your own domain using using AWS Certificate Manager, and use this on the load balancer for HTTTPS traffic (docs). In addition, you can add a CloudFront distribution to improve the connectivity and host your certificate on CloudFront instead.

Logs and Distributed Tracing

All the backend template components leverage AWS X-Ray for distributed tracing, as well as AWS CloudWatch for logs. You can find both the logs and the tracing map and individual trace information the AWS CloudWatch console.

Preliminary setup

Set the const issuerEndpointUrl in BackendComponentSamples/bin/backend_component_samples.ts to the value of IssuerEndpointUrl found in the stack outputs of the CustomIdentityComponentStack. You can find it in the CloudFormation console, or in the terminal after deploying the identity component.

The issuer endpoint is a CloudFormation parameter and the value you set above sets the default value. It's also possible to set the endpoint later on as part of the CDK stack deployment using command line parameters (--parameters IssuerEndpointUrl=<YOUR-ENDPOINT-HERE>).

Serverless REST API sample component template

It is recommended to deploy the serverless API Gateway HTTP API backed component template next to test out your integration from a game engine. The templates work as starting points for your own backend development. We'll deploy the PythonServerlessHttpApiStack that can be found in BackendComponentSamples.

To deploy the component, follow the Preliminary Setup, and then run the following commands (Note: on Windows make sure to run in Powershell as Administrator):

  1. cd .. to return to the root and cd BackendComponentSamples to navigate to samples
  2. npm install to install CDK app dependencies
  3. cdk synth to synthesize the CDK app and validate your configuration works
  4. cdk deploy PythonServerlessHttpApiStack --no-previous-parameters to deploy the CDK app to your account. It's also possible to set the issuer endpoint here using command line parameters (--parameters IssuerEndpointUrl=<YOUR-ENDPOINT-HERE>).

You'll see a new stack deployed in the AWS CloudFormation console, with an API Gateway HTTP API to set and get player data, backed up with Python Lambda functions and an Amazon DynamoDB PlayerData table.

Architecture

The solution uses Python on AWS Lambda for managing requests to get and set player data. Requests are autenticated on the API Gateway level by validating the JWT token in the Authorization header against the public keys provided by our custom identity component. This is using the native integration of the API Gateway HTTP API.

The python functions use Powertools for Lambda (Python) to provide detailed tracing in AWS X-Ray.

High Level Reference Architecture

Loadbalanced AWS Fargate sample component template

Another option is to deploy the AWS Fargate sample component that deploys an AWS Fargate service with an Application Load Balancer, and use Node.js on the server side. It leverages the aws-verify-jwt package to verify the JWT tokens received from the backend, and sets and gets player data in a DynamoDB table in the same way as the Serverless sample component. You can optionally use this Fargate component as your test integration point within the game engines

To deploy the component, follow the Preliminary Setup, and then run the following commands (Note: on Windows make sure to run in Powershell as Administrator):

  1. Make sure you have Docker running before you open the terminal, as the deployment process creates a Docker image
  2. cd .. to return to the root and cd BackendComponentSamples to navigate to samples
  3. npm install to install CDK app dependencies
  4. cdk synth to synthesize the CDK app and validate your configuration works
  5. cdk deploy NodeJsFargateApiStack --no-previous-parameters to deploy the CDK app to your account. It's also possible to set the issuer endpoint here using command line parameters (--parameters IssuerEndpointUrl=<YOUR-ENDPOINT-HERE>).

Architecture

The solution has an Application Load Balancer, that integrates with an auto-scaling Node.js application running on AWS Fargate. The application is integrated with AWS X-Ray for distributed tracing by adding a sidecar container for the X-Ray daemon and using the X-Ray SDK to trace requests and integrations with other AWS services. The app is an express web server that will handle set and get requests for player data with authenticated users. It also responds to the health check sent by the Application Load Balancer.

High Level Reference Architecture