Metaplay Docs

Appearance

Upgrade and Remove Deployments

How to upgrade cloud deployments to newer versions and remove them when no longer needed.

Dependencies ​

  • Cloud deployment - You need to have a Cloud Deployment to upgrade or remove.
  • Metaplay CLI - You need to have the Metaplay CLI installed.

Key Concepts ​

  • A Cloud Deployment consists of a game server and its supporting resources running in a Cloud Environment.
  • A Cloud Environment is a pre-provisioned set of cloud resources capable of running a game server and all its tooling.
  • Helm is a package manager for Kubernetes that we use to deploy the game server and its dependencies, such as the other Metaplay services that the game server needs to run.

Overview ​

When deploying a game server to an Environment, we actually deploy a Helm chart to the Environment first. The Helm chart is a package that describes the Kubernetes resources and configurations that make up the game server and its dependencies.

We maintain a metaplay-gameserver Helm chart that gets updated with new SDK releases. Not all SDK versions are backwards compatible with old charts, so we generally recommend updating your Cloud Deployment to use the latest chart version when you update the SDK. This brings in the latest security fixes and features to keep your Cloud Deployments up to date.

Environment details page

You can see your current Helm chart version from the environment details page in the developer portal.

There are three Helm operations that you can perform on a Cloud Deployment:

  1. Install - The initial setup of a Cloud Deployment. The Metaplay CLI does this for you when you make a new deployment.
  2. Upgrade - Updating an existing Cloud Deployment to use a new chart version. The Metaplay CLI does this for you when doing repeated deployments.
  3. Uninstall - Removing a Cloud Deployment from an Environment, deleting all its resources and configurations.

Updating a Cloud Deployment ​

Updating an existing deployment is simple. You change the active chart version to a new version in your configs and do a new deployment.

The currently active chart version is defined by serverChartVersion in your metaplay-project.yaml. To update to a new version, simply change the value:

metaplay-project.yaml
yaml
serverChartVersion: 0.x.y
serverChartVersion: 0.8.0

With the value changed, you can simply do a new deployment and the Metaplay CLI will upgrade the Cloud Deployment to use the new chart version.

bash
metaplay deploy server

Removing a Cloud Deployment ​

Removing a Cloud Deployment will delete all its resources, secrets and configurations from the Environment. This is useful when you no longer need the Cloud Deployment or when you want to return it to a clean, empty state.

⚠️ Heads-Up: Data Loss Ahead!

Removing a Cloud Deployment is a destructive operation and cannot be undone. All data stored in the Cloud Deployment will be lost.

To remove a Cloud Deployment from an Environment, simply run:

bash
metaplay remove server [ENVIRONMENT]