- Resource: Rollout
- ApprovalState
- State
- FailureCause
- Phase
- State
- DeploymentJobs
- Job
- State
- DeployJob
- VerifyJob
- PredeployJob
- PostdeployJob
- CreateChildRolloutJob
- AdvanceChildRolloutJob
- ChildRolloutJobs
- Metadata
- AutomationRolloutMetadata
- Methods
Resource: Rollout
A Rollout
resource in the Cloud Deploy API.
A Rollout
contains information around a specific deployment to a Target
.
JSON representation |
---|
{ "name": string, "uid": string, "description": string, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "approveTime": string, "enqueueTime": string, "deployStartTime": string, "deployEndTime": string, "targetId": string, "approvalState": enum ( |
Fields | |
---|---|
name |
Optional. Name of the |
uid |
Output only. Unique identifier of the |
description |
Description of the |
annotations |
User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. An object containing a list of |
labels |
Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:
Both keys and values are additionally constrained to be <= 128 bytes. An object containing a list of |
create |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
approve |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
enqueue |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deploy |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deploy |
Output only. Time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
target |
Required. The ID of Target to which this |
approval |
Output only. Approval state of the |
state |
Output only. Current state of the |
failure |
Output only. Additional information about the rollout failure, if available. |
deploying |
Output only. The resource name of the Cloud Build |
etag |
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
deploy |
Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. |
phases[] |
Output only. The phases that represent the workflows of this |
metadata |
Output only. Metadata contains information about the rollout. |
controller |
Output only. Name of the |
rollback |
Output only. Name of the |
rolled |
Output only. Names of |
active |
Output only. The AutomationRun actively repairing the rollout. |
ApprovalState
Valid approval states of a Rollout
.
Enums | |
---|---|
APPROVAL_STATE_UNSPECIFIED |
The Rollout has an unspecified approval state. |
NEEDS_APPROVAL |
The Rollout requires approval. |
DOES_NOT_NEED_APPROVAL |
The Rollout does not require approval. |
APPROVED |
The Rollout has been approved. |
REJECTED |
The Rollout has been rejected. |
State
Valid states of a Rollout
.
Enums | |
---|---|
STATE_UNSPECIFIED |
The Rollout has an unspecified state. |
SUCCEEDED |
The Rollout has completed successfully. |
FAILED |
The Rollout has failed. |
IN_PROGRESS |
The Rollout is being deployed. |
PENDING_APPROVAL |
The Rollout needs approval. |
APPROVAL_REJECTED |
An approver rejected the Rollout . |
PENDING |
The Rollout is waiting for an earlier Rollout(s) to complete on this Target . |
PENDING_RELEASE |
The Rollout is waiting for the Release to be fully rendered. |
CANCELLING |
The Rollout is in the process of being cancelled. |
CANCELLED |
The Rollout has been cancelled. |
HALTED |
The Rollout is halted. |
FailureCause
Well-known rollout failures.
Enums | |
---|---|
FAILURE_CAUSE_UNSPECIFIED |
No reason for failure is specified. |
CLOUD_BUILD_UNAVAILABLE |
Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission. |
EXECUTION_FAILED |
The deploy operation did not complete successfully; check Cloud Build logs. |
DEADLINE_EXCEEDED |
Deployment did not complete within the alloted time. |
RELEASE_FAILED |
Release is in a failed state. |
RELEASE_ABANDONED |
Release is abandoned. |
VERIFICATION_CONFIG_NOT_FOUND |
No Skaffold verify configuration was found. |
CLOUD_BUILD_REQUEST_FAILED |
Cloud Build failed to fulfill Cloud Deploy's request. See failureMessage for additional details. |
OPERATION_FEATURE_NOT_SUPPORTED |
A Rollout operation had a feature configured that is not supported. |
Phase
Phase represents a collection of jobs that are logically grouped together for a Rollout
.
JSON representation |
---|
{ "id": string, "state": enum ( |
Fields | |
---|---|
id |
Output only. The ID of the Phase. |
state |
Output only. Current state of the Phase. |
skip |
Output only. Additional information on why the Phase was skipped, if available. |
Union field jobs . The job composition of this Phase. jobs can be only one of the following: |
|
deployment |
Output only. Deployment job composition. |
child |
Output only. ChildRollout job composition. |
State
Valid states of a Phase.
Enums | |
---|---|
STATE_UNSPECIFIED |
The Phase has an unspecified state. |
PENDING |
The Phase is waiting for an earlier Phase(s) to complete. |
IN_PROGRESS |
The Phase is in progress. |
SUCCEEDED |
The Phase has succeeded. |
FAILED |
The Phase has failed. |
ABORTED |
The Phase was aborted. |
SKIPPED |
The Phase was skipped. |
DeploymentJobs
Deployment job composition.
JSON representation |
---|
{ "deployJob": { object ( |
Fields | |
---|---|
deploy |
Output only. The deploy Job. This is the deploy job in the phase. |
verify |
Output only. The verify Job. Runs after a deploy if the deploy succeeds. |
predeploy |
Output only. The predeploy Job, which is the first job on the phase. |
postdeploy |
Output only. The postdeploy Job, which is the last job on the phase. |
Job
Job represents an operation for a Rollout
.
JSON representation |
---|
{ "id": string, "state": enum ( |
Fields | |
---|---|
id |
Output only. The ID of the Job. |
state |
Output only. The current state of the Job. |
skip |
Output only. Additional information on why the Job was skipped, if available. |
job |
Output only. The name of the |
Union field job_type . The type of Job. job_type can be only one of the following: |
|
deploy |
Output only. A deploy Job. |
verify |
Output only. A verify Job. |
predeploy |
Output only. A predeploy Job. |
postdeploy |
Output only. A postdeploy Job. |
create |
Output only. A createChildRollout Job. |
advance |
Output only. An advanceChildRollout Job. |
State
Valid states of a Job.
Enums | |
---|---|
STATE_UNSPECIFIED |
The Job has an unspecified state. |
PENDING |
The Job is waiting for an earlier Phase(s) or Job(s) to complete. |
DISABLED |
The Job is disabled. |
IN_PROGRESS |
The Job is in progress. |
SUCCEEDED |
The Job succeeded. |
FAILED |
The Job failed. |
ABORTED |
The Job was aborted. |
SKIPPED |
The Job was skipped. |
IGNORED |
The Job was ignored. |
DeployJob
This type has no fields.
A deploy Job.
VerifyJob
This type has no fields.
A verify Job.
PredeployJob
A predeploy Job.
JSON representation |
---|
{ "actions": [ string ] } |
Fields | |
---|---|
actions[] |
Output only. The custom actions that the predeploy Job executes. |
PostdeployJob
A postdeploy Job.
JSON representation |
---|
{ "actions": [ string ] } |
Fields | |
---|---|
actions[] |
Output only. The custom actions that the postdeploy Job executes. |
CreateChildRolloutJob
This type has no fields.
A createChildRollout Job.
AdvanceChildRolloutJob
This type has no fields.
An advanceChildRollout Job.
ChildRolloutJobs
ChildRollouts job composition
JSON representation |
---|
{ "createRolloutJobs": [ { object ( |
Fields | |
---|---|
create |
Output only. List of CreateChildRolloutJobs |
advance |
Output only. List of AdvanceChildRolloutJobs |
Metadata
Metadata includes information associated with a Rollout
.
JSON representation |
---|
{ "cloudRun": { object ( |
Fields | |
---|---|
cloud |
Output only. The name of the Cloud Run Service that is associated with a |
automation |
Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout. |
custom |
Output only. Custom metadata provided by user-defined |
AutomationRolloutMetadata
AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.
JSON representation |
---|
{ "promoteAutomationRun": string, "advanceAutomationRuns": [ string ], "repairAutomationRuns": [ string ] } |
Fields | |
---|---|
promote |
Output only. The name of the AutomationRun initiated by a promote release rule. |
advance |
Output only. The names of the AutomationRuns initiated by an advance rollout rule. |
repair |
Output only. The names of the AutomationRuns initiated by a repair rollout rule. |
Methods |
|
---|---|
|
Advances a Rollout in a given project and location. |
|
Approves a Rollout. |
|
Cancels a Rollout in a given project and location. |
|
Creates a new Rollout in a given project and location. |
|
Gets details of a single Rollout. |
|
Ignores the specified Job in a Rollout. |
|
Lists Rollouts in a given project and location. |
|
Retries the specified Job in a Rollout. |