package peloton.api.v0.update

Get desktop application:
View/edit binary Protocol Buffers messages

Runtime state of a job update

Used in: UpdateStatus, svc.GetUpdateCacheResponse, private.models.UpdateModel

• INVALID = 0

  Invalid protobuf value

• INITIALIZED = 1

  The update has been created but not started yet

• ROLLING_FORWARD = 2

  The update is rolling forward

• PAUSED = 3

  The update has been paused

• SUCCEEDED = 4

  The update has completed successfully

• ABORTED = 5

  The update was aborted/cancelled

• FAILED = 6

  The update is failed

• ROLLING_BACKWARD = 7

  The update is rolling barckward

• ROLLED_BACK = 8

  The update was rolled back due to failure

* Update options for a job update

Used in: UpdateInfo, svc.CreateUpdateRequest, private.models.UpdateModel

• uint32 batchSize = 1

  Update batch size of the deployment

• double batchPercentage = 2

  Update batch percentage of the deployment. If present, will take precedence over batchSize

• bool stopBeforeUpdate = 3

  Whether or not to stop all instance before update

• bool startPaused = 4

  startPaused indicates if the update should start in the paused state, requiring an explicit resume to initiate.

• bool rollbackOnFailure = 5

  rollbackOnFailure indicates if the update should be rolled back automatically if failure is detected

• uint32 maxInstanceAttempts = 6

  maxInstanceAttempts is the maximum attempt times for one task. If the value is 0, the instance can be retried for infinite times.

• uint32 maxFailureInstances = 7

  maxFailureInstances is the number of failed instances in one update that allowed. If the value is 0, there is no limit for max failure instances and the update is marked successful even if all of the instances fail.

• bool inPlace = 8

  If set to true, peloton would try to place the task restarted/updated on the host it previously run on. It is best effort, and has no guarantee of success.

• bool startTasks = 9

  Experimental: this flag is for experimental purpose and will be removed in the future release. If set to true, peloton would start tasks updated if the tasks are killed previously. By default, killed tasks would remain killed, and run with new version when running again.

* Information of an update, such as update config and runtime status

Used in: svc.GetUpdateResponse, svc.ListUpdatesResponse

• optional peloton.UpdateID updateId = 1

  Update ID of the job update

• optional UpdateConfig config = 2

  Update configuration

• optional UpdateStatus status = 3

  Update runtime status

• optional peloton.JobID jobId = 4

  Job ID of the job update

• uint64 configVersion = 5

  Configuration version of the job after this update

• uint64 prevConfigVersion = 6

  Job configuration version before the update

• optional peloton.OpaqueData opaque_data = 7

  Opaque metadata provided by the user

* UpdateStatus provides current runtime status of an update

Used in: UpdateInfo

• uint32 numTasksDone = 1

  Number of tasks that have been updated

• uint32 numTasksRemaining = 2

  Number of tasks to be updated

• State state = 3

  Runtime state of the update

• uint32 numTasksFailed = 4

  Number of tasks that failed during the update