ComposeDeploymentUpgradeDescription

Describes the parameters for a compose deployment upgrade.

Hierarchy

ComposeDeploymentUpgradeDescription

Index

Properties

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

Defines a health policy used to evaluate the health of an application or one of its children entities.

composeFileContent

composeFileContent: string

The content of the compose file that describes the deployment to create.

deploymentName

deploymentName: string

The name of the deployment.

Optional forceRestart

forceRestart: undefined | false | true

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

Optional registryCredential

registryCredential: RegistryCredential

Credential information to connect to container registry.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

upgradeKind

upgradeKind: UpgradeKind

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).