ComposeDeploymentUpgradeProgressInfo

Describes the parameters for a compose deployment upgrade.

Properties

DeploymentName

Type: string
Required: No

The name of the target deployment.

ApplicationName

Type: string
Required: No

The name of the target application, including the 'fabric:' URI scheme.

UpgradeState

Type: string (enum)
Required: No

The state of the compose deployment upgrade.

Possible values are:

• Invalid - Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
• ProvisioningTarget - The upgrade is in the progress of provisioning target application type version. The value is 1.
• RollingForwardInProgress - The upgrade is rolling forward to the target version but is not complete yet. The value is 2.
• RollingForwardPending - The current upgrade ___domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
• UnprovisioningCurrent - The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4.
• RollingForwardCompleted - The upgrade has finished rolling forward. The value is 5.
• RollingBackInProgress - The upgrade is rolling back to the previous version but is not complete yet. The value is 6.
• UnprovisioningTarget - The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7.
• RollingBackCompleted - The upgrade has finished rolling back. The value is 8.
• Failed - The upgrade has failed and is unable to execute FailureAction. The value is 9.

UpgradeStatusDetails

Type: string
Required: No

Additional detailed information about the status of the pending upgrade.

UpgradeKind

Type: string (enum)
Required: No
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

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

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

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.

TargetApplicationTypeVersion

Type: string
Required: No

The target application type version (found in the application manifest) for the application upgrade.

UpgradeDuration

Type: string
Required: No

The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

CurrentUpgradeDomainDuration

Type: string
Required: No

The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

ApplicationUnhealthyEvaluations

Type: array of HealthEvaluationWrapper
Required: No

List of health evaluations that resulted in the current aggregated health state.

CurrentUpgradeDomainProgress

Type: CurrentUpgradeDomainProgressInfo
Required: No

Information about the current in-progress upgrade ___domain. Not applicable to node-by-node upgrades.

StartTimestampUtc

Type: string
Required: No

The estimated UTC datetime when the upgrade started.

FailureTimestampUtc

Type: string
Required: No

The estimated UTC datetime when the upgrade failed and FailureAction was executed.

FailureReason

Type: string (enum)
Required: No

The cause of an upgrade failure that resulted in FailureAction being executed.

Possible values are:

• None - Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero.
• Interrupted - There was an external request to roll back the upgrade. The value is 1
• HealthCheck - The upgrade failed due to health policy violations. The value is 2
• UpgradeDomainTimeout - An upgrade ___domain took longer than the allowed upgrade ___domain timeout to process. The value is 3
• OverallUpgradeTimeout - The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4

UpgradeDomainProgressAtFailure

Type: FailureUpgradeDomainProgressInfo
Required: No

Information about the upgrade ___domain progress at the time of upgrade failure.

ApplicationUpgradeStatusDetails

Type: string
Required: No

Additional details of application upgrade including failure message.