ComposeDeploymentUpgradeDescription

  • Article

Describes the parameters for a compose deployment upgrade.

Properties

Name Type Required
DeploymentName string Yes
ComposeFileContent string Yes
RegistryCredential RegistryCredential No
UpgradeKind string (enum) Yes
RollingUpgradeMode string (enum) No
UpgradeReplicaSetCheckTimeoutInSeconds integer (int64) No
ForceRestart boolean No
MonitoringPolicy MonitoringPolicyDescription No
ApplicationHealthPolicy ApplicationHealthPolicy No

DeploymentName

Type: string
Required: Yes

The name of the deployment.

ComposeFileContent

Type: string
Required: Yes

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

RegistryCredential

Type: RegistryCredential
Required: No

Credential information to connect to container registry.

UpgradeKind

Type: string (enum)
Required: Yes
Default: Rolling

The kind of upgrade out of the following possible values.

Possible values are:

  • Invalid - Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • Rolling - The upgrade progresses one upgrade domain at a time. The value is 1

RollingUpgradeMode

Type: string (enum)
Required: No
Default: UnmonitoredAuto

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.

Possible values are:

  • Invalid - Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • UnmonitoredAuto - The upgrade will proceed automatically without performing any health monitoring. The value is 1
  • UnmonitoredManual - The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
  • Monitored - The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
  • UnmonitoredDeferred - Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4

UpgradeReplicaSetCheckTimeoutInSeconds

Type: integer (int64)
Required: No

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).

ForceRestart

Type: boolean
Required: No

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

MonitoringPolicy

Type: MonitoringPolicyDescription
Required: No

Describes the parameters for monitoring an upgrade in Monitored mode.

ApplicationHealthPolicy

Type: ApplicationHealthPolicy
Required: No

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