Service

Classsealednet10.0

📦 Aspire.Hosting.Docker v13.6.0

Represents a Docker Compose service definition.

namespace Aspire.Hosting.Docker.Resources.ComposeNodes;

public sealed class Service
    : Aspire.Hosting.Docker.Resources.ComposeNodes.NamedComposeMember
{
    // ...
}

NamedComposeMember

57 members

Remarks

This class provides YAML mapping for various properties associated with a service in Docker Compose, such as image, container configuration, environment variables, networks, and more. It is designed to map directly to the service properties defined in a Docker Compose YAML file.

Constructors1

Service

View all constructors

Properties52

Buildget; set

Build?

Represents the build configuration for the service. This is used to specify the context, Dockerfile, or other related configurations required to build the Docker image for the service.

CapAddget; set

List<string>

Specifies a list of Linux capabilities to add to the container.

CapDropget; set

List<string>

Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.

CgroupParentget; set

string?

Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.

Commandget; set

List<string>

Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.

Configsget; set

List<ConfigReference>

Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.

ContainerNameget; set

string?

Specifies the name of the container to be used. This property maps to the "container_name" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.

DependsOnget; set

Dictionary<string, ServiceDependency>

Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: "service_started", "service_healthy", "service_completed_successfully" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.

Deployget; set

Deploy?

Represents the deployment configuration of a service in a Docker Compose configuration.

Devicesget; set

List<string>

Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.

Dnsget; set

List<string>

Gets or sets a list of custom DNS server IP addresses to be used by the service container.

DnsSearchget; set

List<string>

Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.

DomainNameget; set

string?

Represents the domain name of a service container.

Entrypointget; set

List<string>

Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.

EnvFileget; set

List<string>

Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.

Environmentget; set

Dictionary<string, string>

Represents a collection of environment variables for the service container.

Exposeget; set

List<string>

Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.

ExternalLinksget; set

List<string>

Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.

ExtraHostsget; set

Dictionary<string, string>

Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.

GroupAddget; set

List<string>

Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.

Healthcheckget; set

Healthcheck?

Represents the health check configuration for a service. This property specifies the parameters for evaluating the health status of a Docker service container, including commands, intervals, retries, and status conditions. It allows you to define custom health check logic to ensure the service is functioning as expected.

Hostnameget; set

string?

Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.

Imageget; set

string?

Specifies the Docker image to be used for the service.

Initget; set

bool?

Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.

Ipcget; set

string?

Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as "none", "host", or a specific container ID to share IPC resources with.

Isolationget; set

string?

Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include "default", "process", or "hyperv", and the supported options may depend on the container runtime or the platform being used.

Labelsget; set

Dictionary<string, string>

Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.

Linksget; set

List<string>

Represents a service definition in a Docker Compose configuration file.

Loggingget; set

Logging?

Represents the logging configuration for a service in a Docker Compose file. This property allows defining logging options such as drivers and parameters to customize how logs are handled and stored for the service.

MacAddressget; set

string?

Specifies a custom MAC (Media Access Control) address for the container's network interface.

NetworkModeget; set

string?

Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.

Networksget; set

List<string>

Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.

Pidget; set

string?

Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.

Portsget; set

List<string>

Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.

Privilegedget; set

bool?

Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.

Profilesget; set

List<string>

Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.

PullPolicyget; set

string?

Specifies the policy for pulling the Docker image.

ReadOnlyget; set

bool?

Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.

Restartget; set

string?

Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include "no", "always", "on-failure", and "unless-stopped".

Secretsget; set

List<SecretReference>

Represents a collection of secret references used by the service.

SecurityOptget; set

List<string>

Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.

ShmSizeget; set

string?

Gets or sets the size of the /dev/shm partition for the container.

StdinOpenget; set

bool?

Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.

StopGracePeriodget; set

string?

Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as "10s" for 10 seconds or "1m" for 1 minute.

StopSignalget; set

string?

Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.

Sysctlsget; set

Dictionary<string, string>

Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.

Tmpfsget; set

List<string>

Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.

Ttyget; set

bool?

Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.

Ulimitsget; set

Dictionary<string, Ulimit>

Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.

Userget; set

string?

Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., "UID:GID").

Volumesget; set

List<Volume>

Defines the list of volumes to be mounted into the service's container.

WorkingDirget; set

string?

Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the "working_dir" property in a Docker Compose file.

View all properties

Methods4

AddConfig(ConfigReference)

Service

Adds a configuration reference to the service's list of configurations. This method allows you to include external configuration resources that the service can utilize at runtime.

AddEnvironmentalVariable(string, string?)

Service

Adds an environmental variable to the service's environment dictionary. If the specified value is null, it assigns an empty string as the value.

AddVolume(Volume)

Service

Adds a volume to the service's list of volumes. If the volumes collection is null, it initializes a new collection before adding the volume.

AddVolumes(IEnumerable<Volume>)

Service

Adds multiple volumes to the service's list of volumes. If the volumes collection is empty, the provided volumes will be appended to the existing collection.

View all methods

Examples

The Service class can be used to define a container's image, ports, volumes, environment settings, and advanced settings like logging and health checks.