Skip to main content Crate docker_compose_config Copy item path Source AdvancedBuildStep Specifies the build configuration for creating a container image from source, as defined in the Compose Build Specification . Bind Configuration specific to bind mounts. BlkioLimit Block IO limit for a specific device. BlkioSettings Defines a set of configuration options to set block I/O limits for a service. BlkioWeight Block IO weight for a specific device. ComposeFile Configuration settings for a Docker Compose file. CredentialSpec Configures the credential spec for a managed service account. DependsOnSettings With the depends_on attribute, you can control the order of service startup and shutdow``` Deploy Compose Deploy Specification https://docs.docker.com/reference/compose-file/deploy DevelopmentSettings Specifies the development configuration for maintaining a container in sync with source. Device Device reservations for containers, allowing services to access specific hardware devices. DeviceMappingSettings A device mapping for a container. DiscreteResourceSpec Specification for discrete (countable) resources. EnvFileDetailed Detailed configuration for an environment file. GenericResource User-defined resources for services, allowing services to reserve specialized hardware resources. GpuSettings Requires: Docker Compose 2.30.0 and later Healthcheck Declares a check that’s run to determine whether or not the service containers are “healthy”. ImageVolumeSettings IncludeSettings Compose application or sub-projects to be included. Ipam Specifies a custom IPAM configuration. IpamConfig IPAM specific configurations. Limits Resource constraints and reservations for the service. LoggingSettings Defines the logging configuration. Placement Specifies constraints and preferences for the platform to select a physical node to run service containers. See more: https://docs.docker.com/reference/compose-file/deploy/#placement PortSettings Settings for a port mapping. Preferences Defines a strategy (currently spread is the only supported strategy) to spread tasks evenly over the values of the datacenter node label. Provider Defines a service that Compose won’t manage directly. Compose delegated the service lifecycle to a dedicated or third-party component. Reservations Resource reservations for the service containers. Resources Configures physical resource constraints for container to run on platform. RestartPolicy Configures if and how to restart containers when they exit. If restart_policy is not set, Compose considers the restart field set by the service configuration. RollbackConfig Configures how the service should be rolled back in case of a failing update. Service Defines a service for a Compose application. ServiceConfigOrSecretSettings Configuration for service configs or secrets, defining how they are mounted in the container. ServiceHook Configuration for service lifecycle hooks, which are commands executed at specific points in a container’s lifecycle. ServiceModelSettings ServiceNetworkSettings The networks attribute defines the networks that service containers are attached to, referencing entries under the networks top-level element. ServiceVolumeSettings Configuration for a service volume. TmpfsSettings Configuration specific to tmpfs mounts. TopLevelConfig Defines or references configuration data that is granted to services in your Compose application. TopLevelModel Language Model for the Compose application. TopLevelNetwork Network configuration for the Compose application. TopLevelVolume Volume configuration for the Compose application. UpdateConfig Configures how the service should be updated. Useful for configuring rolling updates. VolumeSettings Configuration specific to volume mounts. WatchItem An element of the watch mode configuration. BuildStep Cgroup Specify the cgroup namespace to join. Use ‘host’ to use the host’s cgroup namespace, or ‘private’ to use a private cgroup namespace. DependsOn With the depends_on attribute, you can control the order of service startup and shutdown. DependsOnCondition DeployMode Defines the replication model used to run a service or job. See more: https://docs.docker.com/reference/compose-file/deploy/#mode DeviceMapping A device mapping for a container. EndpointMode Specifies a service discovery method for external clients connecting to a service. See more: https://docs.docker.com/reference/compose-file/deploy/#endpoint_mode Envfile Defines an environment file(s) to use to define default values when interpolating variables in the Compose file being parsed. EnvfileFormat Defines an environment file(s) to use to define default values when interpolating variables in the Compose file being parsed. Extends extends lets you share common configurations among different files, or even different projects entirely.ExtraHosts Adds hostname mappings to the container network interface configuration (/etc/hosts for Linux). Gpus Requires: Docker Compose 2.30.0 and later Include ListOrMap LoggingDriver A logging driver for Docker. NetworkMode Sets a service container’s network mode. OperationsOrder What to do if an update fails. Port PortMode Propagation The propagation mode for the bind mount Protocol ProviderOptions PullPolicy Defines the decisions Compose makes when it starts to pull images. Recursive Recursively mount the source directory. Restart RestartPolicyCondition The condition that should trigger a restart. RollbackFailureAction What to do if an update fails. SELinux ServiceConfigOrSecret Configuration for service configs or secrets, defining how they are mounted in the container. ServiceModels Requires: Docker Compose 2.38.0 and later ServiceNetworks ServiceVolume SingleValue StringOrList StringOrNum StringOrSortedList TopLevelSecret Secret configuration for the Compose application. Ulimit UpdateFailureAction What to do if an update fails. Uts Configures the UTS namespace mode set for the service container. When unspecified it is the runtime’s decision to assign a UTS namespace, if supported. VolumeType The mount type. WatchAction Action to take when a change is detected.