RollingUpdates

Caution: This is a deprecated version of the Instance Group Updater API. Please use the latest Instance Group Updater version instead.

A single Update resource represents a rolling update to the specified managed instance group. Rolling updates apply to existing and new instances in the managed instance group and for existing instances, the updater will recreate each instance with the new template, one at a time.

Rolling updates can be paused, rolled back, or restarted. You can only apply a rolling update to managed instance groups.

For a list of methods for this resource, see the end of this page.

Resource representations

The following represents a resource describing a single update (rollout) of a group of instances to the given template.

{
  "kind": "replicapoolupdater#rollingUpdate",
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "instanceGroupManager": string,
  "instanceGroup": string,
  "actionType": string,
  "instanceTemplate": string,
  "policy": {
    "maxNumConcurrentInstances": integer,
    "autoPauseAfterInstances": integer,
    "maxNumFailedInstances": integer,
    "minInstanceUpdateTimeSec": integer,
    "instanceStartupTimeoutSec": integer
  },
  "user": string,
  "description": string,
  "status": string,
  "statusMessage": string,
  "progress": integer,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  }
}
Property name Value Description Notes
actionType string Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional textual description of the resource; provided by the client when the resource is created.
error object [Output Only] Errors that occurred during the rolling update.
error.errors[] list [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
id string [Output Only] Unique identifier for the resource; defined by the server.
instanceGroup string Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
instanceGroupManager string Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set.
instanceTemplate string Fully-qualified URL of an instance template to apply.
kind string [Output Only] Type of the resource.
policy object Parameters of the update process.
policy.autoPauseAfterInstances integer Number of instances to update before the updater pauses the rolling update.
policy.instanceStartupTimeoutSec integer The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.
policy.maxNumConcurrentInstances integer The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.
policy.maxNumFailedInstances integer The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.
policy.minInstanceUpdateTimeSec integer The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.
progress integer [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses.
status string [Output Only] Status of the update. Possible values are:
  • "ROLLING_FORWARD": The update is going forward.
  • "ROLLING_BACK": The update is being rolled back.
  • "PAUSED": The update is temporarily paused (inactive).
  • "ROLLED_OUT": The update is finished, all instances have been updated successfully.
  • "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
  • "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template.
statusMessage string [Output Only] An optional textual description of the current status of the update.
user string [Output Only] User who requested the update, for example: user@example.com.

Methods

cancel
Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED.
get
Returns information about an update.
insert
Inserts and starts a new update.
list
Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.
listInstanceUpdates
Lists the current status for each instance within a given update.
pause
Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.
resume
Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT.
rollback
Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK.

Send feedback about...

Compute Engine Documentation