Class DockerVolumeManager

Namespace

Bielu.Microservices.Orchestrator.Docker

Assembly

Bielu.Microservices.Orchestrator.Docker.dll

Docker implementation of the volume manager.

public class DockerVolumeManager : IVolumeManager

Inheritance

object

DockerVolumeManager

Implements

IVolumeManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

VolumeManagerExtensions.CreateLocalBoundAsync(IVolumeManager, string, string, LocalMountOptions, CancellationToken)

Constructors

DockerVolumeManager(DockerClient, ILogger<DockerVolumeManager>)

Docker implementation of the volume manager.

public DockerVolumeManager(DockerClient client, ILogger<DockerVolumeManager> logger)

Parameters

client DockerClient

logger ILogger<DockerVolumeManager>

Methods

CreateAsync(string, string?, IDictionary<string, string>?, CancellationToken)

Creates a new volume.

public Task<VolumeInfo> CreateAsync(string name, string? driver = null, IDictionary<string, string>? driverOptions = null, CancellationToken cancellationToken = default)

Parameters

name string

Volume name.

driver string

Storage driver. Defaults to "local".

driverOptions IDictionary<string, string>

Driver-specific options (e.g. type, o, device for local-driver bind volumes).

cancellationToken CancellationToken

Cancellation token.

Returns

Task<VolumeInfo>

GetAsync(string, CancellationToken)

Gets detailed information about a specific volume, or null if not found.

public Task<VolumeInfo?> GetAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

cancellationToken CancellationToken

Returns

Task<VolumeInfo>

ListAsync(CancellationToken)

Lists all volumes.

public Task<IReadOnlyList<VolumeInfo>> ListAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<VolumeInfo>>

RemoveAsync(string, bool, CancellationToken)

Removes a volume.

public Task RemoveAsync(string name, bool force = false, CancellationToken cancellationToken = default)

Parameters

name string

force bool

cancellationToken CancellationToken

Returns

Task