UpdateStage interface
Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage.
Properties
| after |
A list of Gates that will be created after this Stage is executed. |
| after |
The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. |
| before |
A list of Gates that will be created before this Stage is executed. |
| groups | Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. |
| max |
The max number of upgrades that can run concurrently across all groups in this stage. Acts as a ceiling (and not a quota) for the number of concurrent upgrades within the stage you want to tolerate at a time. Actual concurrency may be lower depending on group-level concurrency limits or individual member conditions. Stage maxConcurrency has a min value of "1". Accepts either: • A fixed count, e.g., "3" • A percentage, e.g., "25%" (range 1–100). Percentage is of the total number of clusters across all groups in the stage. Fractional results are rounded down. A minimum of 1 upgrade is enforced. Examples: • "3" --> up to 3 clusters from this stage upgrade at once (across all groups). • "100%" --> “all at once”; up to all clusters in this stage upgrade at the same time. • "25%" --> up to 25% of the stage’s total clusters upgrade at the same time. |
| name | The name of the stage. Must be unique within the UpdateRun. |
Property Details
afterGates
A list of Gates that will be created after this Stage is executed.
afterGates?: GateConfiguration[]Property Value
afterStageWaitInSeconds
The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified.
afterStageWaitInSeconds?: numberProperty Value
number
beforeGates
A list of Gates that will be created before this Stage is executed.
beforeGates?: GateConfiguration[]Property Value
groups
Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.
groups?: UpdateGroup[]Property Value
maxConcurrency
The max number of upgrades that can run concurrently across all groups in this stage. Acts as a ceiling (and not a quota) for the number of concurrent upgrades within the stage you want to tolerate at a time. Actual concurrency may be lower depending on group-level concurrency limits or individual member conditions. Stage maxConcurrency has a min value of "1". Accepts either: • A fixed count, e.g., "3" • A percentage, e.g., "25%" (range 1–100). Percentage is of the total number of clusters across all groups in the stage. Fractional results are rounded down. A minimum of 1 upgrade is enforced. Examples: • "3" --> up to 3 clusters from this stage upgrade at once (across all groups). • "100%" --> “all at once”; up to all clusters in this stage upgrade at the same time. • "25%" --> up to 25% of the stage’s total clusters upgrade at the same time.
maxConcurrency?: stringProperty Value
string
name
The name of the stage. Must be unique within the UpdateRun.
name: stringProperty Value
string