package api.v1.capsule.rollout

Get desktop application:
View/edit binary Protocol Buffers messages

A step configuring a capsule.

Used in: ConfigureStep

• optional StepInfo info = 1

  Step information.

• ConfigureResult state = 2

  The state of the step.

A step committing the changes to git

Used in: ConfigureStep

• optional StepInfo info = 1

  Step information

• string commit_hash = 2

  The hash of the commit containing the changes

• string commit_url = 3

  The url to the commit (if known. May be empty)

A step configuring an environment.

Used in: ConfigureStep

• optional StepInfo info = 1

  Step information.

• ConfigureResult state = 2

  The result of the environment configuration.

• bool is_secret = 3

  Whether the environment is a secret.

A step configuring a file.

Used in: ConfigureStep

• optional StepInfo info = 1

  Step information.

• ConfigureResult state = 2

  The result of the file configuration.

• string path = 3

  The path of the file.

• bool is_secret = 4

  Whether the file is a secret.

The result of a configuration step.

Used in: ConfigureCapsuleStep, ConfigureEnvStep, ConfigureFileStep

• CONFIGURE_RESULT_UNSPECIFIED = 0

  The result is unspecified.

• CONFIGURE_RESULT_CREATED = 1

  The resource is to be created.

• CONFIGURE_RESULT_UPDATED = 2

  The resource is to be updated.

• CONFIGURE_RESULT_NO_CHANGE = 3

  The resource has no change.

• CONFIGURE_RESULT_DELETED = 4

  The resource is to be deleted.

The configure stage.

Used in: Stages

• optional StageInfo info = 1

  Stage information.

• repeated ConfigureStep steps = 2

  The steps of the stage.

A step of the configure stage.

Used in: ConfigureStage

• oneof step

  • GenericStep generic = 1

    A generic step.

  • ConfigureCapsuleStep configure_capsule = 2

    A step configuring a capsule.

  • ConfigureFileStep configure_file = 3

    A step configuring a file.

  • ConfigureEnvStep configure_env = 4

    A step configuring an environment.

  • ConfigureCommitStep commit = 5

    A step for commiting the changes to git.

A step creating a resource.

Used in: ResourceCreationStep

• optional StepInfo info = 1

  Step information.

• string kind = 2

  The kind of the resource.

• string name = 3

  The name of the resource.

A generic step of a stage.

Used in: ConfigureStep, ResourceCreationStep, RunningStep

• optional StepInfo info = 1

  Step information.

Information on the instances of the rollout.

Used in: RunningStep

• optional StepInfo info = 1

  Step information.

• uint32 num_updated = 2

  The number of updated instances.

• uint32 num_ready = 3

  The number of ready instances.

• uint32 num_stuck = 4

  The number of stuck instances.

• uint32 num_wrong_version = 5

  The number of instances with the wrong version.

The resource creation stage.

Used in: Stages

• optional StageInfo info = 1

  Stage information.

• repeated ResourceCreationStep steps = 2

  The steps of the stage.

A step of the resource creation stage.

Used in: ResourceCreationStage

• oneof step

  • GenericStep generic = 1

    A generic step.

  • CreateResourceStep create_resource = 2

    A step creating a resource.

Different result of a rollout.

Used in: Status

• RESULT_UNSPECIFIED = 0

  The result is unspecified.

• RESULT_REPLACED = 1

  The rollout has been replaced.

• RESULT_FAILED = 2

  The rollout has failed.

• RESULT_ABORTED = 3

  The rollout has been aborted.

• RESULT_ROLLBACK = 4

  The rollout has been rolled back.

The running stage.

Used in: Stages

• optional StageInfo info = 1

  Stage information.

• repeated RunningStep steps = 2

  The steps of the stage.

A step of the running stage.

Used in: RunningStage

• oneof step

  • GenericStep generic = 1

    A generic step.

  • InstancesStep instances = 2

    A step containing information on the instances of the rollout.

Information about a stage of a rollout.

Used in: ConfigureStage, ResourceCreationStage, RunningStage

• string name = 1

  Name of the stage.

• optional google.protobuf.Timestamp updated_at = 2

  The last time the stage was updated.

• StageState state = 3

  The current state of the stage.

• optional google.protobuf.Timestamp started_at = 4

  The time the stage started.

Different states a stage can be in.

Used in: StageInfo

• STAGE_STATE_UNSPECIFIED = 0

  The state is unspecified.

• STAGE_STATE_DEPLOYING = 1

  The stage is deploying.

• STAGE_STATE_RUNNING = 2

  The stage is running.

• STAGE_STATE_STOPPED = 3

  The stage is stopped.

The three stages of a rollout

Used in: Status

• optional ConfigureStage configure = 1

  The configure stage.

• optional ResourceCreationStage resource_creation = 2

  The resource creation stage.

• optional RunningStage running = 3

  The running stage.

Different states a rollout can be in.

Used in: Status

• STATE_UNSPECIFIED = 0

  The state is unspecified.

• STATE_PREPARING = 1

  The rollout is preparing.

• STATE_CONFIGURE = 2

  The rollout is configuring.

• STATE_RESOURCE_CREATION = 3

  The rollout is creating resources.

• STATE_RUNNING = 4

  The rollout is running.

• STATE_STOPPED = 5

  The rollout is stopped.

Status is a representation of the current state of a rollout.

Used in: Rollout

• uint64 rollout_id = 1

  The ID of the rollout.

• State state = 2

  The current state of the rollout.

• optional Stages stages = 3

  The stages of the rollout.

• optional google.protobuf.Timestamp updated_at = 4

  The last time the rollout was updated.

• Result result = 5

  The result of the rollout.

Information about a step of a stage.

Used in: ConfigureCapsuleStep, ConfigureCommitStep, ConfigureEnvStep, ConfigureFileStep, CreateResourceStep, GenericStep, InstancesStep

• string name = 1

  Name of the step.

• string message = 2

  Messages in the step.

• optional google.protobuf.Timestamp updated_at = 3

  The last time the step was updated.

• StepState state = 4

  The current state of the step.

• optional google.protobuf.Timestamp started_at = 5

  The time the step started.

Different states a step can be in.

Used in: activity.Message.Rollout, StepInfo

• STEP_STATE_UNSPECIFIED = 0

  The state is unspecified.

• STEP_STATE_ONGOING = 1

  The step is ongoing.

• STEP_STATE_FAILED = 2

  The step failed.

• STEP_STATE_DONE = 3

  The step is done.