Follow the instructions in this guide to deploy an updated game image build to your fleet.
Prerequisites
-
You’ve completed the Multiplay Integrations Process
-
You’ve received your Service Identifiers from the Integrations Team
-
You have an updated game image that you’re ready to deploy to your fleet
These instructions assume that you have a new game build ready in Steam, an S3 bucket, or a Google Cloud bucket. If you have opted to have the Multiplay support team manually install your game build to your jump machine, you can skip the Deploy the Update to your build machine section.
Process overview
The process for updating your game image via the Clanforge API comprises three primary steps:
-
Create an image update on your build machine.
-
Create a difference analysis from the update.
-
Create a new image version from the difference analysis results.
We highly recommend that you test your game image on your build machine before proceeding from step one to step two.
Step 1. Deploy the update to your build machine
Use the Image Update Create endpoint to deploy an update game image to your build machine. You have the option to use Steam, Google Cloud, or AWS. If you don’t have a cloud bucket or Steam account configured with your game image, contact the Multiplay Support Team.
We recommend that you test the updated game image on your build machine before continuing any further. This way, if there’s anything wrong with the image, you’ll catch it before deploying it to the rest of your infrastructure.
Step 2. Create a difference analysis
Use the Image Diff Create endpoint to create a difference analysis (also called a diff analysis) based on the updated game image on your build machine. Once you’ve generated a diff analysis, you can check the status of the diff analysis creation job, reject the diff analysis, or create a new image version from the diff analysis.
|
Check the diff analysis status |
After sending the request to create the diff analysis, you can use the Image Diff Status endpoint to check the current status of the diff analysis job. |
|
|
Reject the diff analysis |
Reject the results of the diff analysis if it contains any unexpected changes. After you reject the diff analysis by the unique diff ID, you can generate a new diff analysis. If you attempt to generate another diff analysis from the same game image before rejecting or accepting the outstanding diff analysis, you will receive an error stating that the image is locked by the diff ID XXXX. |
|
|
Retry the diff analysis |
If the diff analysis failed, troubleshoot the failure, then retry the diff analysis |
|
|
Create a new image version from the diff analysis |
Creating a new image version from a diff analysis is the same as accepting the results of the diff analysis. |
Step 3. Deploy the update to your fleet machines
To deploy the update generated from the diff analysis, use the Image Version Create endpoint with the diff ID returned from the Image Diff Create request. The Image Version Create endpoint accepts the differences in the diff analysis (as specified by the diff ID in the request body), creates an update, and deploys the update to your fleet.
After you’ve called the Image Version Create endpoint, you can call the Image Update Status endpoint to check the status of the update. The statuses (job states) of the Image Version Status endpoint are described in the table below.
|
1 |
Created (new job) |
|
2 |
Pending (waiting to be queued) |
|
3 |
Queued (waiting to be processed) |
|
4 |
Running (in process) |
|
5 |
Completed (successful) |
|
6 |
Failed (unsuccessful) |
If you encounter any problems while deploying the update to your fleet machines, contact the Customer Success team.