Dependencies

• Download the metaplay-gameserver Helm chart - This Helm chart helps make swift Deployments into Metaplay Cloud. The chart can be found at https://charts.metaplay.dev/
• Working knowledge of Helm - To make the most out of this page, you should have a basic understanding of how to use Helm values and files. Check out Helm's documentation for information on values and files.

Key Concepts

• Helm chart: A package that generates Kubernetes manifests and deploys applications into Kubernetes clusters.
• Helm values: Various YAML entries that compose a collection of settings.
• Helm deployment file: A YAML file that consists of a set of Helm values and shall be consumed by a Helm chart.
• metaplay-gameserver Helm chart: A Helm chart published by Metaplay for making smooth deployments into Metaplay Cloud. The chart can be found at https://charts.metaplay.dev/

Overview

The metaplay-gameserver Helm chart comes with default Helm values that are configured for a vanilla Deployment. However, you may want to further tailor the Helm values to fit the actual needs of your game server.

Here, we provide you with some examples.

Quick Start

By default, each Helm chart comes with a values.yaml file under its root directory, providing pre-defined settings that can be overridden.

The metaplay-gameserver Helm chart abides by the same standard. You can inspect all default settings of the metaplay-gameserver Helm chart by downloading the chart from https://charts.metaplay.dev/. Search for the keyword metaplay-gameserver and you will find all available versions of the metaplay-gameserver Helm chart. To download a specific Helm chart, append metaplay-gameserver-<chart version>.tgz to the URL. The values.yaml file will be available under the root directory after extraction.

To customize a deployment, you need to modify the Backend\Deployments\<env>.yaml file accordingly. The YAML file will be read by the metaplay-gameserver Helm chart when installing/upgrading a deployment and overriding any default settings that come with the metaplay-gameserver Helm chart.

INFO

For more details on how the metaplay-gameserver Helm chart consumes Backend\Deployments\<env>.yaml, please visit the Deploy a Game Server section.

Examples

Specifying an Image Repository

By default, the metaplay-auth CLI tool will upload game server images into Metaplay Cloud with the push-docker-image command, and those images will be available when making a Deployment without the need to specify an image repository.

However, if you want to make a Deployment with game server images persisted in other service providers (e.g., DockerHub), you need to modify the image block:

# server image to use
image:
  repository:  # "some.repository.url/repositoryName"
  tag:         # "latest"
  pullSecrets: # "secret"
  pullPolicy:  # "image pull policy"

Enable Experimental Features

Metaplay constantly publishes experimental features that are disabled by default until fully tested. To enable certain experimental features for a deployment, you need to explicitly add YAML entries into Backend\Deployments\<env>.yaml under the experimental key:

# Enable experimental features
experimental:
  <feature name>:
    enabled: true
    # ... other feature-specific settings
  # ... more features