UpdateConfig Class

Definition

Namespace:: Aspire.Hosting.Docker.Resources.ServiceNodes.Swarm

Assembly:: Aspire.Hosting.Docker.dll

Package:: Aspire.Hosting.Docker v9.2.0-preview.1.25209.2

Package:: Aspire.Hosting.Docker v9.3.0-preview.1.25265.20

Source:: UpdateConfig.cs

Source:: UpdateConfig.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the update configuration settings for service deployments in a Docker Swarm environment.

[YamlDotNet.Serialization.YamlSerializable]
public sealed class UpdateConfig

[<YamlDotNet.Serialization.YamlSerializable>]
type UpdateConfig = class

Public NotInheritable Class UpdateConfig

Inheritance: Object
UpdateConfig

Attributes: YamlDotNet.Serialization.YamlSerializableAttribute

Remarks

This class provides various configurable options for updating services, including parallelism, delay between updates, failure actions, monitoring settings, failure ratio limits, and the order of updates.

Constructors

UpdateConfig()

Properties

Delay	Represents the delay between each update operation for a service node in a swarm configuration.
FailOnError	Indicates whether the update process should stop and fail upon encountering an error.
MaxFailureRatio	Gets or sets the maximum failure ratio allowed during the update process. This property specifies the threshold for the ratio of failed tasks over the total number of tasks during a service update. If the failure ratio exceeds this value, the update will be rolled back or stopped depending on the configured failure action.
Monitor	Gets or sets the duration or interval for monitoring the progress of an update. This property is typically used to specify the time span the system will monitor the update process before determining its status (success or failure).
Order	Represents the execution order of service updates during the update process. Specifies the sequence in which the update operations are applied (e.g., "start-first" or "stop-first").
Parallelism	Gets or sets the level of parallelism applied during the update process. This property specifies the maximum number of service tasks that can be updated simultaneously.

Applies to

Share via