REST Resource: projects.locations.deployments.actuations

Resource: Actuation

The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.

JSON representation 
{
  "name": string,
  "actuationOutput": {
    object (ActuationOutput)
  },
  "state": enum (State),
  "deploymentOutput": [
    {
      object (DeploymentOutput)
    }
  ],
  "startTime": string,
  "endTime": string
}
Fields
name

string

The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}
actuationOutput

object (ActuationOutput)

Output only. [Output only] Actuation output
state

enum (State)

Output only. [Output only] Actuation state
deploymentOutput[]

object (DeploymentOutput)

Output only. [Output only] Deployment output
startTime

string (Timestamp format)

Output only. [Output only] Start time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. [Output only] End time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ActuationOutput

Message for output of Actuation

JSON representation 
{
  "blueprintId": string,
  "terraformTemplate": string,
  "errorLogs": string,
  "actuateLogs": string,
  "errorCode": enum (ErrorCode),
  "ansibleError": string,
  "cloudbuildId": string,
  "ansibleFailedTask": [
    string
  ],
  "terraformError": string,
  "hasUserFacingErrorMsg": boolean
}
Fields
blueprintId

string

reference to Blueprint Controller deployment and revision resource
terraformTemplate

string

reference to terraform template used
errorLogs

string

A link to actuation cloud build log.
actuateLogs

string

A link to gcs file that store build logs
errorCode

enum (ErrorCode)

Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.
ansibleError

string

Output only. error message return from ansible.
cloudbuildId

string

Cloud Build instance UUID associated with this revision, without any suffix or prefix
ansibleFailedTask[]

string

Output only. failed task name return from ansible.
terraformError

string

Output only. error message return from terraform.
hasUserFacingErrorMsg

boolean

Output only. whether the error message is user facing. If true, the error message will be shown in the UI.

ErrorCode

Possible errors that can occur with deployments.

Enums
ERROR_CODE_UNSPECIFIED No error code was specified.
TERRAFORM_FAILED general terraform failure
PERMISSION_DENIED_IN_TERRAFORM permission error in terraform
QUOTA_EXCEED_IN_TERRAFORM quota related error in terraform
ANSIBLE_FAILED general ansible failure
CONSTRAINT_VIOLATION_IN_TERRAFORM constraint related error in terraform
RESOURCE_ALREADY_EXISTS_IN_TERRAFORM resource already exists error in terraform
RESOURCE_UNAVAILABLE_IN_TERRAFORM resource not found error in terraform
PERMISSION_DENIED_IN_ANSIBLE permission denied error in ansible
INVALID_SECRET_IN_ANSIBLE secret related error in ansible
TERRAFORM_DELETION_FAILED general terraform failure during deletion
RESOURCE_IN_USE_IN_TERRAFORM_DELETION resource in use error in terraform deletion
ANSIBLE_START_FAILED start up failure in ansible

State

The state of actuation LINT.IfChange

Enums
STATE_UNSPECIFIED state unspecified
INFRA_CREATING creating infrastructure in backend (terraform applying)
SUCCEEDED success
FAILED failed either in infra creating, post infra configuring or infra destroying
POST_INFRA_CONFIGURING configure workload after infrastructure is ready (ansible running)
INFRA_DESTROYING destroying infrastructure in backend (terraform destroying)
TIMEOUT ansible is timeout due to losing heartbeat in post infra configuring

DeploymentOutput

Message for output of deployment resource

JSON representation 
{
  "name": string,
  "type": string
}
Fields
name

string

name of the resource
type

string

type of the resource

Methods

create

 Creates a new actuation for an existing Deployment.

delete

 Deletes a single Actuation

get

 Gets details of a single Actuation.

list

 Lists Actuations in a given project, location and deployment.