- Resource: Rollout
- RolloutInfo
- State
- RolloutStrategyInfo
- AllAtOnceStrategyInfo
- ClusterInfo
- ResourceBundleDeploymentInfo
- SyncState
- State
- RollingStrategyInfo
- Methods
Resource: Rollout
Rollout resource represents an instance of FleetPackage
rollout operation across a fleet. This is a system generated resource and will be read only for end-users. It will be primarily used by the service to process the changes in the FleetPackage
and other changes in the environment.
JSON representation |
---|
{ "name": string, "release": string, "rolloutStrategy": { object ( |
Fields | |
---|---|
name |
Identifier. Name of the Rollout. Format is |
release |
Reference to the |
rolloutStrategy |
Rollout strategy for rolling out |
info |
Current details of the rollout. |
deletionPropagationPolicy |
Deletion propagation policy of the rollout. |
createTime |
Output only. The time the rollout was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time the rollout was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
RolloutInfo
RolloutInfo represents the state of the FleetPackage
at all the clusters the rollout is targeting.
JSON representation |
---|
{ "state": enum ( |
Fields | |
---|---|
state |
Output only. state contains the overall status of the Rollout. |
startTime |
Output only. Time when the rollout started. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. Time when the rollout completed. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
message |
Output only. Message containing additional information related to the rollout. |
rolloutStrategyInfo |
Output only. Rollout strategy info represents the status of execution of rollout strategy. |
State
State of the rollout
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
COMPLETED |
Rollout completed. |
SUSPENDED |
Rollout suspended. |
ABORTED |
Rollout aborted. |
IN_PROGRESS |
Rollout in progress. |
STALLED |
Rollout stalled. |
CANCELLED |
Rollout cancelled. |
RolloutStrategyInfo
RolloutStrategyInfo represents the status of execution of different types of rollout strategies. Only the field corresponding to the rollout strategy specified at the rollout resource will be populated.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field strategy . strategy represents result of applying one of the rollout strategies. strategy can be only one of the following: |
|
allAtOnceStrategyInfo |
AllAtOnceStrategyInfo represents the status of AllAtOnce rollout strategy execution. |
rollingStrategyInfo |
RollingStrategyInfo represents the status of Rolling rollout strategy execution. |
AllAtOnceStrategyInfo
AllAtOnceStrategyInfo represents the status of execution of AllAtOnce rollout strategy.
JSON representation |
---|
{
"clusters": [
{
object ( |
Fields | |
---|---|
clusters[] |
resource bundle's deployment status for all targeted clusters. |
ClusterInfo
ClusterInfo represents status of a resource bundle rollout for a cluster.
JSON representation |
---|
{ "membership": string, "desired": { object ( |
Fields | |
---|---|
membership |
Output only. gkehub membership of target cluster |
desired |
Output only. Desired state for the resource bundle. |
initial |
Output only. Initial state of the resource bundle prior to the deployment. |
current |
Output only. Current state of the resource bundle. |
state |
Output only. State of the rollout for the cluster. |
messages[] |
Output only. Messages convey additional information related to the deployment. |
startTime |
Output only. Timestamp when reconciliation starts. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. Timestamp when reconciliation ends. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
ResourceBundleDeploymentInfo
ResourceBundleDeploymentInfo represents the status of a resource bundle deployment.
JSON representation |
---|
{ "release": string, "version": string, "variant": string, "syncState": enum ( |
Fields | |
---|---|
release |
Output only. Refers to a |
version |
Output only. Refers to a version of the |
variant |
Output only. Refers to a variant in a |
syncState |
Output only. Synchronization state of the |
messages[] |
Output only. Messages contains information related to the |
deletionPropagationPolicy |
Output only. DeletionPropagationPolicy of the |
SyncState
Synchronization state of the resource bundle deployment.
Enums | |
---|---|
SYNC_STATE_UNSPECIFIED |
Unspecified state. |
RECONCILING |
Reconciling state. |
STALLED |
Stalled state. |
SYNCED |
Synced state. |
PENDING |
Pending state. |
ERROR |
Error state. |
DELETION_PENDING |
Deletion pending state. |
DELETING |
Deleting state. |
DELETED |
Deleted state. |
State
State of the rollout for the cluster.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
WAITING |
Waiting state. |
IN_PROGRESS |
In progress state. |
STALLED |
Stalled state. |
COMPLETED |
Completed state. |
ABORTED |
Aborted state. |
CANCELLED |
Cancelled state. |
ERROR |
Error state. |
RollingStrategyInfo
RollingStrategyInfo represents the status of execution of Rolling rollout strategy.
JSON representation |
---|
{
"clusters": [
{
object ( |
Fields | |
---|---|
clusters[] |
resource bundle's deployment status for all targeted clusters. |
Methods |
|
---|---|
|
Abort a Rollout. |
|
Gets details of a single Rollout. |
|
Lists Rollouts in a given project, location, and fleet package. |
|
Resume a Rollout. |
|
Suspend a Rollout. |