Documentation

Support

Multiplay Hosting

Multiplay Hosting

Container build workflow

Follow this workflow to create and deploy container-based builds using the API.
Read time 2 minutesLast updated 3 days ago
The container build workflow includes the following steps: Before using the container build workflow, you must have a CCD API key and a UGS service account with the following roles:
  • Multiplay API Viewer
  • Multiplayer API Editor
  • Multiplay Registry Editor
The following diagram shows a simplified version of the workflow:
container workflow diagram

container workflow diagram

Prepare the build container

  1. Build the container image (using an out-of-band process).
  2. Take note of your Unity project ID and environment ID.
  3. Log into the Multiplay Hosting container registry.
  4. Use your Key ID for the username and Secret Key for the password. Refer to Authentication.
docker login registry.multiplay.com -u <KeyID>

Get or create a build

The process for getting a build varies depending on whether you want to use an existing build or create a new build.

Get an existing build by name

You can retrieve an existing build ID by name using the List Builds API. Remember to make note of the 
buildID
of the build you want to use. The following code sample shows how to get an existing build using curl: 
curl -X GET -H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" https://services.api.unity.com/multiplay/builds/v1/projects/{projectId}/environments/{environmentId}/builds
After finding the build you want to use, make a note of the 
buildID
from the response body.

Create a new build

You can create a new build using the Create build API. The following code sample shows how to create a build using curl: 
curl -X POST -H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" -H "Content-Type: application/json" \-d '{"buildName":"Dev Build A", "osFamily": "LINUX"}' \https://services.api.unity.com/multiplay/builds/v1/projects/{projectId}/environments/{environmentId}/builds
After creating the new build, make a note of the 
buildID
from the response body.

Tag the container image

The first time you push to a new build, use 
v1
as the 
MultiplayTag
. After the first push, use incremental tags (for example, 
v2
). Use the following code snippet as template for tagging the container (where 
ImageName
and 
ImageTag
are your local image name and tag). 
docker tag <ImageName>:<ImageTag> registry.multiplay.com/<ProjectID>/<EnvironmentID>/<BuildID>:<MultiplayTag>

Push the image to the container registry

After tagging the container, push it to the Multiplay Hosting container registry. Use the following code snippet as a template: 
docker push registry.multiplay.com/<ProjectID>/<EnvironmentID>/<BuildID>:<MultiplayTag>
Once you push a tag, you cannot use that tag again for the same build; Multiplay Hosting prevents pushing the same tag more than once for a build to ensure that the exact same container is pulled during scaling. Refer to Zero downtime releases for more information.

Create a build version

You can create a build version with the Create a new build version API. The following code sample shows how to create a build version using curl: 
curl -X POST -H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" -H "Content-Type: application/json" \-d '{"container": {"imageTag": "v1"}, "forceRollout": false}' \https://services.api.unity.com/multiplay/builds/v1/projects/{projectId}/environments/{environmentId}/builds/{buildId}/versions