Application Build Management
Last updated
Last updated
Application Build Management is the process of creating and maintaining builds for your . An ApplicationBuild defines the software that will be deployed by our system. It can be a game server or a utility (side car). Whenever you have a software update, you must upload the new build to our system and create an ApplicationBuild for it before it can be deployed.
Before you can create an element, you must first create:
with elements
Please refer to the chapter for more information on creating these elements.
Additionally you must have uploaded a build archive to your .
An ApplicationBuild is represented by the following element:
The process flow of creating an ApplicationBuild is visualized in the below.
The following diagram is a simple overview depicting the process of creating an ApplicationBuild. Note that you must first before you can start this process. The chapter after that provides an example for more detail.
The ApplicationBuild creation process can be summarized as follows:
Figure 1: ApplicationBuild creation process
This is the first step; uploading your build(s) to your origin. Note that in the future you will be able to upload your builds via our control panel as well.
JSON response data BuildProvisioningFile:
Here we take the values for buildProvisioningFileId
and buildProvisioningRegistrationId
from the previous GET /v3/buildProvisioning/storage/file
request.
In this case you must provide a bit more details than with an i3D.net hosted origin, because in this self-hosted case, we have no knowledge of which files are hosted on your origin. So you must provide the buildProvisioningRegistrationId
, followed by fields you must manually enter for your build file:
domain: the domain of your origin
path: the path within which your build archive resides
filename: the file name of your build archive
headers: key/value array of HTTP headers for your security, to lock down access to the files on your origin. You can enter any kind of header keys (header name) and values (header value).
Upon submission we will validate these details, and see if we get a 200 OK response for a HEAD request, meaning the file could be reached by our platform. If this call succeeds, you will get the newly created ApplicationBuild in the response body of the request. You could optionally verify its existence using the ApplicationBuild's ID:
We now have a complete ApplicationBuild element pointing to an ApplicationBuildFile (representing the build archive you uploaded earlier) and the following definitions:
a name (must be unique)
the Application element this element belongs to
the file path (including file name) to the executable that we need to start the instance
startupParameters to accompany the executable
operating system needed for the build to run on. This must match exactly the operating system on your servers (BM & VM), otherwise the platform will refuse to run your build
When you have , or when you have setup and , you can upload your build archive there.
When the upload is finished our system will index the files in your account and make them all available via . Take note of the file IDs, you will need these when creating the ApplicationBuild element below.
JSON request data :
JSON request data :
JSON response data :