This page explains how to create, list, and describe Game Servers deployments. A deployment manages one or more software versions that you can deploy to any or all realms.
Before you begin
Before you start, we recommend you familiarize yourself with key concepts in the Game Servers Overview. Make sure you have also performed the following tasks:
- Ensure that you have enabled the Game Services API. Enable Game Services API
- Either choose a shell with Cloud SDK installed, or use an API client:
Go to Google Cloud Console.
From the upper-right corner of the console, click the Activate Cloud Shell button:
Cloud Shell
To launch Cloud Shell, perform the following steps:
A Cloud Shell session opens inside a frame lower on the console.
You use this shell to run gcloud
commands.
Local shell
To install gcloud
, install the Cloud SDK,
which includes the gcloud
command-line tool.
Verify that you have set desired default project for gcloud
command-line tool (otherwise you need to specify flag --project
explicitly for each command later):
gcloud config list project
If not you can run the following command to set a default project, replacing project-id
with your desired project ID :
gcloud config set project project-id
Run the following command to verify your version of the Google Cloud SDK.
Game Servers requires version 306.0.0
or higher of the SDK.
gcloud version
To update your installation, run the following command:
gcloud components update
Client Library
Google Cloud Game Servers can be controlled programmatically using a client library. See Client Libraries Overview for instructions on using the library and authenticating.
Creating a deployment
Console
In the Cloud Console, go to the Game Server Deployments page.
Click Create Deployment.
In the Name box, enter a unique identifier for this deployment.
(Optional) In the Description box, enter a description for this deployment.
Click Create.
gcloud
You can create a deployment using the gcloud
command-line tool.
To create a deployment, run the following command and replace the deploymentID, with an appropriate value:
gcloud game servers deployments create deploymentID
Go
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Java
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Node.js
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Python
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Listing deployments
Console
In the Cloud Console, go to the Game Server Deployments page.
You can use the filter box to filter the deployments list by different properties.
gcloud
You can list deployments using the gcloud
command-line tool.
To list deployments, run the following command:
gcloud game servers deployments list
Go
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Java
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Node.js
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Python
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Describing a deployment
Console
In the Cloud Console, go to the Game Server Deployments page.
You can use the filter box to filter the deployments list by different properties.
In the last table column, click the ellipses more_vert and select List configs. You can view the active and inactive configs for the deployment from this page.
To create a new config for the deployment, click Create Config. To update the rollout, click Manage Rollout.
gcloud
You can obtain details about a deployment, such as the creation time or update time,
using the gcloud
command-line tool.
To describe a deployment, run the following command and replace deploymentID with the identifier for a deployment you have previously created:
gcloud game servers deployments describe deploymentID
Go
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Java
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Node.js
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
Python
To learn how to install and use the client library for Game Servers, see the Game Servers Client Libraries.
What's next
- Learn how to create a config.
- Learn how to delete a deployment.