Skip to main content

Service Configuration Reference

build - Configuration options that are applied at build time​

  1. context - Either a path to a directory containing a Dockerfile, or a url to a git repository

  2. dockerfile - Alternate Dockerfile

  3. args - Add build arguments, which are environment variables accessible only during the build process

  4. cache_from - A list of images that the engine uses for cache resolution

  5. labels - Add metadata to the resulting image using Docker labels. You can use either an array or a dictionary.

  6. shm_size - Set the size of the/dev/shmpartition for this build's containers. Specify as an integer value representing the number of bytes or as a string expressing a byte value.

  7. target - Build the specified stage as defined inside theDockerfile

cap_add, cap_drop​

Add or drop container capabilities

command​

Override the default command.

configs​

Grant access to configs on a per-service basis using the per-serviceconfigsconfiguration.

cgroup_parent​

Specify an optional parent cgroup for the container.

container_name​

Specify a custom container name, rather than a generated default name.

credential_spec​

Configure the credential spec for managed service account.

deploy​

Specify configuration related to the deployment and running of services. This only takes effect when deploying to a swarm with docker stack deploy, and is ignored bydocker-compose upanddocker-compose run.

1. endpoint_mode (vip / dnsrr)​

Specify a service discovery method for external clients connecting to a swarm.

2. labels​

Specify labels for the service. These labels are onlyset on the service, and noton any containers for the service.

3. mode​

Eitherglobal(exactly one container per swarm node) orreplicated(a specified number of containers). The default isreplicated.

4. placement​

Specify placement of constraints and preferences.

5. replicas​

If the service isreplicated(which is the default), specify the number of containers that should be running at any given time.

6. resources​

Configures resource constraints.

deploy: resources: limits: cpus: '0.50' memory: 50M reservations: cpus: '0.25' memory: 20M

7. Out Of Memory Exceptions (OOME)​

If your services or containers attempt to use more memory than the system has available, you may experience an Out Of Memory Exception (OOME) and a container, or the Docker daemon, might be killed by the kernel OOM killer.

8. restart_policy​

Configures if and how to restart containers when they exit. Replaces restart.

  • condition - none/on-failure/any (default: any)
  • delay
  • max_attempts
  • window

9. rollback_config​

10. update_config​

Others​

  1. devices

  2. depends_on

  3. dns

  4. dns_search

  5. tmpfs

  6. entrypoint

  7. env_file

  8. environment

  9. expose

  10. external_links

  11. extra_hosts

  12. healthcheck

  13. image

  14. init

  15. isolation

  16. labels

  17. links

  18. logging

  19. network_mode

  20. networks

    • aliases
    • ipv4, ipv6 addresses

  21. pid

  22. ports

  23. secrets

  24. security_opt

  25. stop_grace_period

  26. stop_signal

  27. sysctls

    sysctls: net.core.somaxconn: 1024 net.ipv4.tcp_syncookies: 0

  28. ulimits

  29. userns_mode

  30. volumes

  31. restart

  32. domainname, hostname, ipc, mac_address, privileged, read_only, shm_size, stdin_open, tty, user, working_dir

Not supported for docker stack deploy

References​

https://docs.docker.com/compose/compose-file