# Aspire.Hosting.Docker

- Package: `Aspire.Hosting.Docker`
- Version: `13.2.0`
- Target framework: `net8.0`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/aad16017893bd769e0634c47fb007f1454735f11/src/Aspire.Hosting.Docker)
- NuGet: [Aspire.Hosting.Docker](https://www.nuget.org/packages/Aspire.Hosting.Docker)

## Namespaces

### Aspire.Hosting

- [DockerComposeAspireDashboardResourceBuilderExtensions](/reference/api/csharp/aspire.hosting.docker/dockercomposeaspiredashboardresourcebuilderextensions.md) -- `class` `static` -- Provides extension methods for creating Aspire Dashboard resources in the application model.
- [DockerComposeEnvironmentExtensions](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions.md) -- `class` `static` -- Provides extension methods for adding Docker Compose environment resources to the application model.
- [DockerComposeServiceExtensions](/reference/api/csharp/aspire.hosting.docker/dockercomposeserviceextensions.md) -- `class` `static` -- Provides extension methods for customizing Docker Compose service resources.

### Aspire.Hosting.Docker

- [CapturedEnvironmentVariable](/reference/api/csharp/aspire.hosting.docker/capturedenvironmentvariable.md) -- `class` `sealed` -- Represents a captured environment variable that will be written to the .env file adjacent to the Docker Compose file.
- [DockerComposeAspireDashboardResource](/reference/api/csharp/aspire.hosting.docker/dockercomposeaspiredashboardresource.md) -- `class` `ats export` -- Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.
- [DockerComposeEnvironmentResource](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentresource.md) -- `class` `ats export` -- Represents a Docker Compose environment resource that can host application resources.
- [DockerComposeServiceCustomizationAnnotation](/reference/api/csharp/aspire.hosting.docker/dockercomposeservicecustomizationannotation.md) -- `class` `sealed` -- Represents an annotation for customizing a Docker Compose service.
- [DockerComposeServiceResource](/reference/api/csharp/aspire.hosting.docker/dockercomposeserviceresource.md) -- `class` `ats export` -- Represents a compute resource for Docker Compose with strongly-typed properties.

### Aspire.Hosting.Docker.Resources

- [ComposeFile](/reference/api/csharp/aspire.hosting.docker/composefile.md) -- `class` `sealed` -- Represents a Docker Compose file with properties and configurations for services, networks, volumes, secrets, configs, and custom extensions.

### Aspire.Hosting.Docker.Resources.ComposeNodes

- [Config](/reference/api/csharp/aspire.hosting.docker/config.md) -- `class` `sealed` -- Represents a configuration object in a Docker Compose file.
- [NamedComposeMember](/reference/api/csharp/aspire.hosting.docker/namedcomposemember.md) -- `class` `abstract` -- Represents a generic named member within a Docker Compose configuration structure.
- [Network](/reference/api/csharp/aspire.hosting.docker/network.md) -- `class` `sealed` -- Represents a Docker network configuration as part of a Compose file.
- [Secret](/reference/api/csharp/aspire.hosting.docker/secret.md) -- `class` `sealed` -- Represents a Secret object in a Docker Compose configuration file.
- [Service](/reference/api/csharp/aspire.hosting.docker/service.md) -- `class` `sealed` `ats export` -- Represents a Docker Compose service definition.
- [ServiceDependency](/reference/api/csharp/aspire.hosting.docker/servicedependency.md) -- `class` `sealed` -- Represents a service dependency in a Docker Compose file.

### Aspire.Hosting.Docker.Resources.ServiceNodes

- [Build](/reference/api/csharp/aspire.hosting.docker/build.md) -- `class` `sealed` -- Represents the build configuration for a service within a Docker Compose file. This class is used to define various build parameters such as context, dockerfile, arguments, target stages, cache sources, and labels.
- [ConfigReference](/reference/api/csharp/aspire.hosting.docker/configreference.md) -- `class` `sealed` -- Represents a reference to a configuration used within a service resource.
- [Healthcheck](/reference/api/csharp/aspire.hosting.docker/healthcheck.md) -- `class` `sealed` -- Represents the health check configuration for a container.
- [Ipam](/reference/api/csharp/aspire.hosting.docker/ipam.md) -- `class` `sealed` -- Represents the IP Address Management (IPAM) configuration for a Docker network.
- [Logging](/reference/api/csharp/aspire.hosting.docker/logging.md) -- `class` `sealed` -- Represents the logging configuration for a service in a containerized environment.
- [SecretReference](/reference/api/csharp/aspire.hosting.docker/secretreference.md) -- `class` `sealed` -- Represents a reference to a secret within a Docker service configuration.
- [Ulimit](/reference/api/csharp/aspire.hosting.docker/ulimit.md) -- `class` `sealed` -- Represents the configuration for system resource limits (ulimits) for a container.
- [Volume](/reference/api/csharp/aspire.hosting.docker/volume.md) -- `class` `sealed` -- Represents a volume definition in a Docker Compose configuration file.

### Aspire.Hosting.Docker.Resources.ServiceNodes.Swarm

- [Deploy](/reference/api/csharp/aspire.hosting.docker/deploy.md) -- `class` `sealed` -- Represents the deployment configuration for a Docker service. This class is used to define various aspects such as replication, mode, resource constraints, updates, and restart policies.
- [LabelSpecs](/reference/api/csharp/aspire.hosting.docker/labelspecs.md) -- `class` `sealed` -- Represents a collection of labels that can be associated with a Docker service. This class is used to define metadata in the form of key-value pairs.
- [Placement](/reference/api/csharp/aspire.hosting.docker/placement.md) -- `class` `sealed` -- Represents the placement configuration for a Docker service in a Swarm cluster. This class is used to define specific constraints and preferences for the placement of tasks or containers.
- [Resources](/reference/api/csharp/aspire.hosting.docker/resources.md) -- `class` `sealed` -- Represents the resource configurations for a Docker service in Swarm mode.
- [ResourceSpec](/reference/api/csharp/aspire.hosting.docker/resourcespec.md) -- `class` `sealed` -- Represents resource specifications for a Docker service.
- [RestartPolicy](/reference/api/csharp/aspire.hosting.docker/restartpolicy.md) -- `class` `sealed` -- Defines the restart policy for a Docker service in a Swarm cluster.
- [UpdateConfig](/reference/api/csharp/aspire.hosting.docker/updateconfig.md) -- `class` `sealed` -- Defines the update configuration settings for service deployments in a Docker Swarm environment.