AWS gamelift documentation change
Summary
Updated documentation to consistently use 'Amazon GameLift Servers' branding throughout, including service names, SDK references, and console mentions. Changed links to SDKs/plugins and updated terminology from 'managed containers' to 'Servers managed containers'.
Security assessment
Changes are nomenclature updates clarifying the service name ('GameLift Servers') rather than addressing security issues. No security vulnerabilities, mitigations, or new security features are mentioned in the diff.
Diff
diff --git a/gamelift/latest/developerguide/gamelift-roadmap-containers.md index 8a9b1bd52..ec2584054 100644 --- a/gamelift/latest/developerguide/gamelift-roadmap-containers.md +++ b/gamelift/latest/developerguide/gamelift-roadmap-containers.md @@ -3 +3 @@ -[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Developer Guide](gamelift-intro.html) +[Documentation](/index.html)[Amazon GameLift](/gamelift/index.html)[Hosting Guide](gamelift-intro.html) @@ -5 +5 @@ -# Development roadmap for hosting with Amazon GameLift managed containers +# Development roadmap for hosting with Amazon GameLift Servers managed containers @@ -7 +7 @@ -This roadmap guides you through how to develop an Amazon GameLift managed hosting solution for your containerized game servers. Managed containers is just one hosting solution that is offered by Amazon GameLift. For more information on hosting options, see [Amazon GameLift solutions](./gamelift-intro-flavors.html). +This roadmap guides you through how to develop an Amazon GameLift Servers managed hosting solution for your containerized game servers. Managed containers is just one hosting solution that is offered by Amazon GameLift Servers. For more information on hosting options, see [Amazon GameLift Servers solutions](./gamelift-intro-flavors.html). @@ -9 +9 @@ This roadmap guides you through how to develop an Amazon GameLift managed hostin -A managed container solution with Amazon GameLift has the following components: +A managed container solution with Amazon GameLift Servers has the following components: @@ -13 +13 @@ A managed container solution with Amazon GameLift has the following components: - * A container image with your game server build, uploaded to Amazon Elastic Container Registry (Amazon ECR) private repository. The game server build is integrated with the Amazon GameLift server SDK and built to run on Linux. + * A container image with your game server build, uploaded to Amazon Elastic Container Registry (Amazon ECR) private repository. The game server build is integrated with the server SDK for Amazon GameLift Servers and built to run on Linux. @@ -15 +15 @@ A managed container solution with Amazon GameLift has the following components: - * A backend service that interacts with the Amazon GameLift service on behalf of your game clients. The backend service uses functionality in the Amazon GameLift service API, which is part of the AWS SDK, + * A backend service that interacts with the Amazon GameLift Servers service on behalf of your game clients. The backend service uses functionality in the service API for Amazon GameLift Servers, which is part of the AWS SDK. @@ -17 +17 @@ A managed container solution with Amazon GameLift has the following components: - * An Amazon GameLift game session queue that processes requests for new game sessions, searches for available game servers across all fleets, and prompts a game server to start a game session. + * An Amazon GameLift Servers game session queue that processes requests for new game sessions, searches for available game servers across all fleets, and prompts a game server to start a game session. @@ -24 +24 @@ A managed container solution with Amazon GameLift has the following components: -This roadmap presents a streamlined path to getting your containerized game servers up and running successfully with Amazon GameLift managed containers. After you have the necessary components in place, you can continue to iterate on game development and customize your hosting solution. As you get closer to launch, see these [Preparing your game for launch with Amazon GameLift hosting](./gamelift_quickstart_customservers_checklist.html) for help with preparing your hosting solution for production-level usage. +This roadmap presents a streamlined path to getting your containerized game servers up and running successfully with Amazon GameLift Servers managed containers. After you have the necessary components in place, you can continue to iterate on game development and customize your hosting solution. As you get closer to launch, see these [Preparing your game for launch with Amazon GameLift Servers hosting](./gamelift_quickstart_customservers_checklist.html) for help with preparing your hosting solution for production-level usage. @@ -28 +28 @@ This roadmap presents a streamlined path to getting your containerized game serv - * The [containers starter kit](https://github.com/aws/amazon-gamelift-toolkit/tree/main/containers-starter-kit) streamlines integration and fleet setup. It adds essential game session management features to your game server, and uses pre-configured templates to build a container fleet and an automated deployment pipeline for your game server. After deployment, use the Amazon GameLift console and API tools to monitor fleet performance, manage game sessions, and analyze metrics. + * The [containers starter kit](https://github.com/aws/amazon-gamelift-toolkit/tree/main/containers-starter-kit) streamlines integration and fleet setup. It adds essential game session management features to your game server, and uses pre-configured templates to build a container fleet and an automated deployment pipeline for your game server. After deployment, use the Amazon GameLift Servers console and API tools to monitor fleet performance, manage game sessions, and analyze metrics. @@ -30 +30 @@ This roadmap presents a streamlined path to getting your containerized game serv - * For Unreal Engine or Unity developers, use the [Amazon GameLift plugins](https://aws.amazon.com/gamelift/getting-started/) to integrate your game server and build a container fleet from inside your game engine's development environment. The plugin's guided workflows help you create a fast, simple solution with cloud-based hosting using managed containers. You can build on this foundation to create a custom hosting solution for your game. + * For Unreal Engine or Unity developers, use the [Amazon GameLift Servers plugins](https://aws.amazon.com/gamelift/servers/getting-started/) to integrate your game server and build a container fleet from inside your game engine's development environment. The plugin's guided workflows help you create a fast, simple solution with cloud-based hosting using managed containers. You can build on this foundation to create a custom hosting solution for your game. @@ -35 +35 @@ This roadmap presents a streamlined path to getting your containerized game serv -Add functionality to your game server so that it can communicate with the Amazon GameLift service when it's deployed for hosting. +Add functionality to your game server so that it can communicate with the Amazon GameLift Servers service when it's deployed for hosting. @@ -37 +37 @@ Add functionality to your game server so that it can communicate with the Amazon - * **Get the Amazon GameLift server SDK (version 5.2 or greater) for your game project.** The server SDK is available in C++, C#, and Go. [ Download the Amazon GameLift server SDK](https://aws.amazon.com/gamelift/getting-started-sdks/). The server SDK is available in C++, C#, and Go. + * **Get the server SDK for Amazon GameLift Servers (version 5.2 or greater) for your game project.** The server SDK is available in C++, C#, and Go. [ Download the server SDK for Amazon GameLift Servers](https://aws.amazon.com/gamelift/servers/getting-started-sdks/). The server SDK is available in C++, C#, and Go. @@ -41 +41 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to initialize the Amazon GameLift SDK and establish a WebSocket connection with the Amazon GameLift service. Use the server SDK action `InitSdk()`. + * Add code to initialize the Amazon GameLift Servers SDK and establish a WebSocket connection with the Amazon GameLift Servers service. Use the server SDK action `InitSdk()`. @@ -43 +43 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to report to the Amazon GameLift service when the server process is ready to host game sessions. Use the server SDK action `ProcessReady()`. + * Add code to report to the Amazon GameLift Servers service when the server process is ready to host game sessions. Use the server SDK action `ProcessReady()`. @@ -45 +45 @@ Add functionality to your game server so that it can communicate with the Amazon - * Implement the required callback functions `OnStartGameSession()`, and `OnProcessTerminate()`. With these functions, game server processes can maintain a connection with the Amazon GameLift service, initiate a game session when prompted by Amazon GameLift, and respond to a request to end the game server process. + * Implement the required callback functions `OnStartGameSession()`, and `OnProcessTerminate()`. With these functions, game server processes can maintain a connection with the Amazon GameLift Servers service, initiate a game session when prompted by Amazon GameLift Servers, and respond to a request to end the game server process. @@ -47 +47 @@ Add functionality to your game server so that it can communicate with the Amazon - * Add code to report to the Amazon GameLift service when the server process is ending a game session. Use the server SDK action `ProcessEnding()`. + * Add code to report to the Amazon GameLift Servers service when the server process is ending a game session. Use the server SDK action `ProcessEnding()`. @@ -51 +51 @@ Add functionality to your game server so that it can communicate with the Amazon - * **Test your game server integration.** Verify that your integrated game server can connect to the Amazon GameLift service and respond to prompts. We recommend setting up a simple Amazon GameLift Anywhere fleet with a local workstation as a test host, as described in [Set up local testing with Amazon GameLift Anywhere](./integration-testing.html). Install your game server build onto the test host and start a server process. Use the AWS CLI to request a new game session, and verify that the Amazon GameLift service successfully prompts your server process to start a game session. + * **Test your game server integration.** Verify that your integrated game server can connect to the Amazon GameLift Servers service and respond to prompts. We recommend setting up a simple Amazon GameLift Servers Anywhere fleet with a local workstation as a test host, as described in [Set up local testing with Amazon GameLift Servers Anywhere](./integration-testing.html). Install your game server build onto the test host and start a server process. Use the AWS CLI to request a new game session, and verify that the Amazon GameLift Servers service successfully prompts your server process to start a game session. @@ -56 +56 @@ Add functionality to your game server so that it can communicate with the Amazon -Create a way for your game client to request to join a game session, get connection info, and then connect directly to a hosted game session. The most common approach is to set up backend service functionality that serves as a middleman between your game client and the Amazon GameLift service. This approach protects your hosting resources and gives you greater control over how players are placed into game sessions. +Create a way for your game client to request to join a game session, get connection info, and then connect directly to a hosted game session. The most common approach is to set up backend service functionality that serves as a middleman between your game client and the Amazon GameLift Servers service. This approach protects your hosting resources and gives you greater control over how players are placed into game sessions. @@ -58 +58 @@ Create a way for your game client to request to join a game session, get connect - * **Build backend service functionality for hosting.** The backend service communicates with the Amazon GameLift service and delivers connection information to a game client. This functionality includes starting game sessions, placing players into games, and retrieving game session information. For guidance, see [Integrate games with custom game servers](./integration-custom-intro.html). At a minimum, do the following: + * **Build backend service functionality for hosting.** The backend service communicates with the Amazon GameLift Servers service and delivers connection information to a game client. This functionality includes starting game sessions, placing players into games, and retrieving game session information. For guidance, see [Integrate games with custom game servers](./integration-custom-intro.html). At a minimum, do the following: @@ -60 +60 @@ Create a way for your game client to request to join a game session, get connect - * Get the AWS SDK for Amazon GameLift and add it to your backend service project. See [Amazon GameLift SDK resources for client services](./gamelift-supported.html#gamelift-supported-clients). + * Get the AWS SDK for Amazon GameLift Servers and add it to your backend service project. See [Amazon GameLift Servers SDK resources for client services](./gamelift-supported.html#gamelift-supported-clients). @@ -62 +62 @@ Create a way for your game client to request to join a game session, get connect - * Add code to initialize an Amazon GameLift client and store key settings. See [Set up Amazon GameLift on a backend service](./gamelift-sdk-client-api.html#gamelift-sdk-client-api-initialize). + * Add code to initialize an Amazon GameLift Servers client and store key settings. See [Set up Amazon GameLift Servers on a backend service](./gamelift-sdk-client-api.html#gamelift-sdk-client-api-initialize). @@ -70 +70 @@ For guidance on designing your backend service, see [Design your game client ser - * **Add functionality to your game client that lets players join a hosted game session.** The game client makes requests to your backend service, not directly to Amazon GameLift. After the backend service provides game session connection information, the game client connects directly with the game session to play the game. + * **Add functionality to your game client that lets players join a hosted game session.** The game client makes requests to your backend service, not directly to Amazon GameLift Servers. After the backend service provides game session connection information, the game client connects directly with the game session to play the game. @@ -72 +72 @@ For guidance on designing your backend service, see [Design your game client ser - * **Test your game client integration.** You can use your existing Amazon GameLift Anywhere fleet with a local workstation for testing. Use the new backend service to request a new game session, and verify that: (1) the Amazon GameLift service successfully prompts your server process to start a game session, and (2) a game client can connect to the game session. + * **Test your game client integration.** You can use your existing Amazon GameLift Servers Anywhere fleet with a local workstation for testing. Use the new backend service to request a new game session, and verify that: (1) the Amazon GameLift Servers service successfully prompts your server process to start a game session, and (2) a game client can connect to the game session. @@ -77 +77 @@ For guidance on designing your backend service, see [Design your game client ser -Customize how you want Amazon GameLift to process requests for new game session and locate available game servers to host them. Amazon GameLift automatically tracks the availability of all game servers on all fleets. When a game client sends a request to join a game session, Amazon GameLift looks for the "best possible" placement based on a set of defined priorities such as minimum latency, cost, and availability. +Customize how you want Amazon GameLift Servers to process requests for new game session and locate available game servers to host them. Amazon GameLift Servers automatically tracks the availability of all game servers on all fleets. When a game client sends a request to join a game session, Amazon GameLift Servers looks for the "best possible" placement based on a set of defined priorities such as minimum latency, cost, and availability. @@ -87 +87 @@ Customize how you want Amazon GameLift to process requests for new game session - * **Add FlexMatch matchmaking (optional).** Build a matchmaking rule set and create a matchmaking configuration to work with your game session queue. For guidance on setting up a matchmaking system, see the [ Amazon GameLift FlexMatch developer guide](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html). + * **Add FlexMatch matchmaking (optional).** Build a matchmaking rule set and create a matchmaking configuration to work with your game session queue. For guidance on setting up a matchmaking system, see the [Amazon GameLift ServersFlexMatch developer guide](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html). @@ -89 +89 @@ Customize how you want Amazon GameLift to process requests for new game session - * **Test the placement system.** You can use your existing Amazon GameLift Anywhere fleet with a local workstation for testing. Use the backend service to request a new game session, and verify that the Amazon GameLift service successfully prompts your server process to start a game session. + * **Test the placement system.** You can use your existing Amazon GameLift Servers Anywhere fleet with a local workstation for testing. Use the backend service to request a new game session, and verify that the Amazon GameLift Servers service successfully prompts your server process to start a game session. @@ -94 +94 @@ Customize how you want Amazon GameLift to process requests for new game session -After you've successfully integrated your game server, create a container image with your game server executable. Store it in an Amazon Elastic Container Registry (Amazon ECR) repository for use with Amazon GameLift. For detailed instructions, see [Build a container image for Amazon GameLift](./containers-prepare-images.html). +After you've successfully integrated your game server, create a container image with your game server executable. Store it in an Amazon Elastic Container Registry (Amazon ECR) repository for use with Amazon GameLift Servers. For detailed instructions, see [Build a container image for Amazon GameLift Servers](./containers-prepare-images.html). @@ -96 +96 @@ After you've successfully integrated your game server, create a container image - * **Get the Dockerfile template for a game server container (provided by Amazon GameLift).** Modify the file for your game server build files. + * **Get the Dockerfile template for a game server container (provided by Amazon GameLift Servers).** Modify the file for your game server build files. @@ -102 +102 @@ After you've successfully integrated your game server, create a container image - * **Test your container images using your Anywhere fleet (optional).** You might want to test your container images locally before deploying them to a cloud-hosted container fleet. You can use your existing Amazon GameLift Anywhere fleet with a local workstation for testing. Install and run the game server container and verify that: (1) the Amazon GameLift service successfully prompts your server process to start a game session, and (2) a game client can connect to the game session. + * **Test your container images using your Anywhere fleet (optional).** You might want to test your container images locally before deploying them to a cloud-hosted container fleet. You can use your existing Amazon GameLift Servers Anywhere fleet with a local workstation for testing. Install and run the game server container and verify that: (1) the Amazon GameLift Servers service successfully prompts your server process to start a game session, and (2) a game client can connect to the game session. @@ -107 +107 @@ After you've successfully integrated your game server, create a container image -Up to this point you've worked with a self-managed Anywhere fleet to test and iterate on your game components. The final piece of your solution is to set up the cloud-based hosting resources that you'll need for a production system. To start planning and configuring for production, you want to set up a Amazon GameLift managed container fleet and customize it for production. +Up to this point you've worked with a self-managed Anywhere fleet to test and iterate on your game components. The final piece of your solution is to set up the cloud-based hosting resources that you'll need for a production system. To start planning and configuring for production, you want to set up a Amazon GameLift Servers managed container fleet and customize it for production. @@ -109 +109 @@ Up to this point you've worked with a self-managed Anywhere fleet to test and it - * **Create container group definitions.** Container group definitions describe the container architecture for a fleet. and identify which container images to deploy. See [Create a container group definition for an Amazon GameLift container fleet](./containers-create-groups.html). Create your container group definition in the same AWS Region where the container images are stored. For more on choosing a fleet location, see [Fleet location](./gamelift-compute.html#gamelift-compute-location). At a minimum, do the following: + * **Create container group definitions.** Container group definitions describe the container architecture for a fleet. and identify which container images to deploy. See [Create a container group definition for an Amazon GameLift Servers container fleet](./containers-create-groups.html). Create your container group definition in the same AWS Region where the container images are stored. For more on choosing a fleet location, see [Fleet location](./gamelift-compute.html#gamelift-compute-location). At a minimum, do the following: @@ -117 +117 @@ Up to this point you've worked with a self-managed Anywhere fleet to test and it - * **Create a managed container fleet.** When you create a fleet, Amazon GameLift immediately begins deploying your game server build for hosting. You can configure many aspects of a managed fleet. For guidance, see [Create an Amazon GameLift managed container fleet](./containers-build-fleet.html). At minimum, do the following: + * **Create a managed container fleet.** When you create a fleet, Amazon GameLift Servers immediately begins deploying your game server build for hosting. You can configure many aspects of a managed fleet. For guidance, see [Create an Amazon GameLift Servers managed container fleet](./containers-build-fleet.html). At minimum, do the following: @@ -119 +119 @@ Up to this point you've worked with a self-managed Anywhere fleet to test and it - * Set up an AWS Identity and Access Management (IAM) service role for the container fleet. See [Set up an IAM service role for Amazon GameLift](./setting-up-role.html). + * Set up an AWS Identity and Access Management (IAM) service role for the container fleet. See [Set up an IAM service role for Amazon GameLift Servers](./setting-up-role.html). @@ -123 +123 @@ Up to this point you've worked with a self-managed Anywhere fleet to test and it - * Use default values where available for all other parameters. Amazon GameLift calculates some parameters for optimal configuration. + * Use default values where available for all other parameters. Amazon GameLift Servers calculates some parameters for optimal configuration. @@ -136 +136 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Optimize your container fleet configuration. See [Customize an Amazon GameLift container fleet](./containers-design-fleet.html). + * Optimize your container fleet configuration. See [Customize an Amazon GameLift Servers container fleet](./containers-design-fleet.html). @@ -138 +138 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Consider adding Spot fleets for cost savings. See [Tutorial: Create an Amazon GameLift queue with Spot Instances](./tutorial-queues-spot.html). + * Consider adding Spot fleets for cost savings. See [Tutorial: Create an Amazon GameLift Servers queue with Spot Instances](./tutorial-queues-spot.html). @@ -142 +142 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Determine where geographically you want to position game servers. Add remote locations to your managed fleets. See [Customize your Amazon GameLift EC2 managed fleets](./fleets-design.html). + * Determine where geographically you want to position game servers. Add remote locations to your managed fleets. See [Customize your Amazon GameLift Servers EC2 managed fleets](./fleets-design.html). @@ -146 +146 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Set up automatic capacity scaling to meet expected player demand. See [Scaling game hosting capacity with Amazon GameLift](./fleets-manage-capacity.html). + * Set up automatic capacity scaling to meet expected player demand. See [Scaling game hosting capacity with Amazon GameLift Servers](./fleets-manage-capacity.html). @@ -150 +150 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Set up hosting observability tools, including analytics and logging. See [Monitoring Amazon GameLift](./monitoring-overview.html). + * Set up hosting observability tools, including analytics and logging. See [Monitoring Amazon GameLift Servers](./monitoring-overview.html). @@ -152 +152 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re - * Automate your fleet deployments using [infrastructure as code (IaC)](https://docs.aws.amazon.com/whitepapers/latest/introduction-devops-aws/infrastructure-as-code.html). See [Managing Amazon GameLift hosting resources using AWS CloudFormation](./resources-cloudformation.html). + * Automate your fleet deployments using [infrastructure as code (IaC)](https://docs.aws.amazon.com/whitepapers/latest/introduction-devops-aws/infrastructure-as-code.html). See [Managing Amazon GameLift Servers hosting resources using AWS CloudFormation](./resources-cloudformation.html). @@ -154 +154 @@ As you prepare for game launch, you'll need to fine-tune your managed hosting re -Amazon GameLift supports the use of AWS CloudFormation templates for any deployment-specific configurations. You can also use the AWS Cloud Development Kit (AWS CDK) to define your Amazon GameLift resources. For more information about the AWS CDK, see the [AWS Cloud Development Kit (AWS CDK) Developer Guide](https://docs.aws.amazon.com/cdk/v2/guide/). +Amazon GameLift Servers supports the use of AWS CloudFormation templates for any deployment-specific configurations. You can also use the AWS Cloud Development Kit (AWS CDK) to define your Amazon GameLift Servers resources. For more information about the AWS CDK, see the [AWS Cloud Development Kit (AWS CDK) Developer Guide](https://docs.aws.amazon.com/cdk/v2/guide/). @@ -160 +160 @@ To manage the deployment of your AWS CloudFormation stacks, we recommend using c - * Upload the binary to Amazon GameLift. + * Upload the binary to Amazon GameLift Servers.