Metaplay Docs

Appearance

Install, Upgrade and Uninstall

This guide provides instructions for some basic operations against a Deployment.

Overview ​

Managing the life cycles of deployments is essential for keeping deployments healthy. There are three actions you can take: install, upgrade, and uninstall.

Dependencies ​

  • Having the metaplay-auth CLI tool installed - The metaplay-auth CLI tool is a powerful utility that provides various commands for interacting with cloud deployments in the Metaplay Cloud. You can get it using npm

How-To Guides ​

Install ​

The install action is used when making a new Deployment into a target Environment in Metaplay Cloud. Please check the Deploy a Game Server section for more details.

Upgrade ​

When you want to patch an existing Deployment with modified Helm values, or want to migrate to use another release of the metaplay-gameserver Helm chart for certain features, you can simply invoke the same metaplay-auth CLI commands as if making a new Deployment:

bash
metaplay-auth \
 deploy-server \ # command for deploying a server
  metaplay-idler-develop \ # specify the target Environment, must be in the format of {Organization}-{Project}-{Environment}
 $IMAGE_TAG \ # the same image tag of the game server that lives within the existing Deployment
 --values=Backend/Deployments/develop-server.yaml \ # updated Helm values file
 --helm-chart-version=<metaplay-gameserver Helm chart version to use>

Uninstall ​

Uninstalling a Deployment requires calling the uninstall-server command from the metaplay-auth CLI:

bash
metaplay-auth \
  uninstall-server \ # command for uninstalling a deployment
  metaplay-idler-develop \ # specify the target Environment, must be in the format of {Organization}-{Project}-{Environment}