Deployment is a versioned configuration for a build that describes runtime behavior.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
additionalContainerPorts |
List<ContainerPort> | ✔️ | Additional ports your server listens on. | { "transportType": "tcp", "port": 4000, "name": "debug" } |
appId |
String | ✔️ | System generated unique identifier for an application. | app-af469a92-5b45-4565-b3c4-b79878de67d2 |
buildId |
int | ✔️ | System generated id for a build. Increments by 1. | 1 |
containerPort |
double | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
createdAt |
OffsetDateTime | ✔️ | When the deployment was created. | |
createdBy |
String | ✔️ | N/A | [email protected] |
defaultContainerPort |
ContainerPort | ✔️ | A container port object represents the transport configruations for how your server will listen. | |
deploymentId |
int | ✔️ | System generated id for a deployment. Increments by 1. | 1 |
env |
List<DeploymentV1Env> | ✔️ | The environment variable that our process will have access to at runtime. | |
idleTimeoutEnabled |
Optional<Boolean> | ➖ | Option to shut down processes that have had no new connections or rooms for five minutes. |
|
planName |
PlanName | ✔️ | A plan defines how much CPU and memory is required to run an instance of your game server.tiny: shared core, 1gb memorysmall: 1 core, 2gb memorymedium: 2 core, 4gb memorylarge: 4 core, 8gb memory |
tiny |
requestedCPU |
double | ✔️ | The number of cores allocated to your process. | 0.5 |
requestedMemoryMB |
int | ✔️ | The amount of memory allocated to your process. | 1024 |
roomsPerProcess |
int | ✔️ | Governs how many rooms can be scheduled in a process. | 3 |
transportType |
DeploymentV1TransportType | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |