REST Resource: projects.locations.deployments

Resource: Deployment

The Deployment object represents user intent for deploying a specific type of workload.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "deploymentSourcesUrl": string,
  "state": enum (State),
  "serviceAccount": string,

  // Union field workload_config can be only one of the following:
  "sapSystemS4Config": {
    object (SapSystemS4Config)
  },
  "hpcToolkitConfig": {
    object (HPCToolkitConfig)
  }
  // End of list of possible types for union field workload_config.
}
Fields
name

string

The name of deployment resource. The format will be 'projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'
description

string

Description of the Deployment
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deploymentSourcesUrl

string

The url contains deployment needed sources files, such as terraform files. Currently only used internally.
state

enum (State)

Output only. Current state of the deployment.
serviceAccount

string

Optional. User-specified Service Account (SA) credentials to be used for cloud build Format: projects/{projectID}/serviceAccounts/{serviceAccount} The default Cloud Build SA will be used initially if this field is not set during deployment creation
Union field workload_config. DeploymentMetadata of the deployment workload_config can be only one of the following:
sapSystemS4Config

object (SapSystemS4Config)

SAP system workload input
hpcToolkitConfig

object (HPCToolkitConfig)

HPC toolkit workload input

SapSystemS4Config

Message for sap system workload

JSON representation 
{
  "gcpProjectId": string,
  "location": {
    object (LocationDetails)
  },
  "database": {
    object (DatabaseDetails)
  },
  "app": {
    object (AppDetails)
  },
  "allowStoppingForUpdate": boolean,
  "version": enum (Version),
  "environmentType": enum (EnvironmentType),
  "deploymentModel": enum (DeploymentModel),
  "scalingMethod": enum (ScalingMethod),
  "mediaBucketName": string,
  "sapBootDiskImage": string,
  "vmPrefix": string
}
Fields
gcpProjectId

string

the project that infrastructure deployed, current only support the same project where the deployment resource exist.
location

object (LocationDetails)

database details
database

object (DatabaseDetails)

database details
app

object (AppDetails)

instance details
allowStoppingForUpdate

boolean
version

enum (Version)

Required. sap hana version
environmentType

enum (EnvironmentType)

Required. deployment environment
deploymentModel

enum (DeploymentModel)

Required. two model non-HA and HA supported
scalingMethod

enum (ScalingMethod)

Required. support scale up and scale out
mediaBucketName

string

Required. mediaBucketName
sapBootDiskImage

string

Optional. sapBootDiskImage
vmPrefix

string

vmPrefix

LocationDetails

Message for sap instant details

JSON representation 
{
  "vpcName": string,
  "zone1Name": string,
  "zone2Name": string,
  "dnsZoneNameSuffix": string,
  "regionName": string,
  "internetAccess": enum (InternetAccess),
  "subnetName": string,
  "dnsZone": string,
  "networkProject": string
}
Fields
vpcName

string

Required. vpcName
zone1Name

string

Required. zone1Name
zone2Name

string

Optional. zone2Name
dnsZoneNameSuffix

string

Optional. dnsZoneNameSuffix
regionName

string

Required. regionName
internetAccess

enum (InternetAccess)
subnetName

string

Required. subnetName
dnsZone

string

Optional. dns zone name
networkProject

string

Optional. network project

InternetAccess

InternetAccess

Enums
INTERNETACCESS_UNSPECIFIED
ALLOW_EXTERNAL_IP
CONFIGURE_NAT

DatabaseDetails

Message for sap instant details

JSON representation 
{
  "sid": string,
  "machineType": string,
  "diskType": string,
  "secretManagerSecret": string,
  "image": string,
  "instanceId": string,
  "primaryDbVm": string,
  "secondaryDbVm": string
}
Fields
sid

string

Required. The SID is a three-digit server-specific unique identification code.
machineType

string

Required. machine type
diskType

string

Required. diskType
secretManagerSecret

string

Required. secretManagerSecret
image

string

Required. image for database server
instanceId

string

Required. instance id
primaryDbVm

string

Optional. primary db vm name
secondaryDbVm

string

Optional. secondary db vm name

AppDetails

Message for sap instant details

JSON representation 
{
  "sid": string,
  "vmsMultiplier": integer,
  "machineType": string,
  "ascsMachineType": string,
  "secretManagerSecret": string,
  "image": string,
  "ascsInstanceId": string,
  "ersInstanceId": string,
  "appInstanceId": string,
  "ascsVm": string,
  "ersVm": string
}
Fields
sid

string

Required. The SAP SID is a three-digit server-specific unique identification code.
vmsMultiplier

integer

Required. vmsMultiplier
machineType

string

Required. machine type
ascsMachineType

string

Required. ascsMachineType
secretManagerSecret

string

Required. secretManagerSecret
image

string

Required. image for app server and ascs server
ascsInstanceId

string

Required. instance id for ascs
ersInstanceId

string

Required. instance id for ers
appInstanceId

string

Required. instance id for app
ascsVm

string

Optional. ASCS vm name
ersVm

string

Optional. ERS vm name

Version

Version

Enums
VERSION_UNSPECIFIED
S4_HANA_2021
S4_HANA_2022

EnvironmentType

EnvironmentType

Enums
ENVIRONMENT_TYPE_UNSPECIFIED
NON_PRODUCTION
PRODUCTION

DeploymentModel

DeploymentModel

Enums
DEPLOYMENT_MODEL_UNSPECIFIED
DISTRIBUTED
DISTRIBUTED_HA
TEST Only use internal for e2e test purpose

ScalingMethod

ScalingMethod

Enums
SCALE_METHOD_UNSPECIFIED
SCALE_UP Scale up: Increases the size of a physical machine by increasing the amount of RAM and CPU available for processing
SCALE_OUT Scale out: Combines multiple independent computers into one system

HPCToolkitConfig

Message for hpc workload

JSON representation 
{
  "blueprintYaml": string
}
Fields
blueprintYaml

string

hpc toolkit blueprint file describe how to deploy workload

State

The state of deployment

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
CREATING The deployment is being created.
ACTIVE The deployment is healthy.
UPDATING The deployment is being updated.
DELETING The deployment is being deleted.
FAILED The deployment has encountered an unexpected error.

Methods

create

 Creates a new Deployment in a given project and location.

delete

 Deletes a single Deployment.

get

 Gets details of a single Deployment.

list

 Lists Deployments in a given project and location.

patch

 Updates the parameters of a single Deployment.