From 5af37129857d0576190ac2da4ca968f923c38e81 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Thu, 23 May 2024 09:39:52 +0100 Subject: [PATCH] ENGDOCS-2080b (#20080) * ENGDOCS-2080b * ENGDOCS-2080b * Update content/compose/compose-file/05-services.md Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --------- Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/compose/compose-file/05-services.md | 4 +++- content/compose/compose-file/11-extension.md | 2 ++ content/includes/compose/extension.md | 4 ++-- content/includes/compose/merge.md | 2 +- content/includes/compose/services-healthcheck.md | 3 +-- content/includes/compose/services-networks.md | 2 +- content/includes/compose/services-secrets.md | 2 +- content/includes/compose/services-volumes.md | 2 +- 8 files changed, 12 insertions(+), 9 deletions(-) diff --git a/content/compose/compose-file/05-services.md b/content/compose/compose-file/05-services.md index 0cbffa53f5c..a04e5471041 100644 --- a/content/compose/compose-file/05-services.md +++ b/content/compose/compose-file/05-services.md @@ -932,7 +932,9 @@ been the case if `group_add` were not declared. ## healthcheck -{{< include "compose/services-healthcheck.md" >}} +{{< include "compose/services-healthcheck.md" >}} + +For more information on `HEALTHCHECK`, see the [Dockerfile reference](../../reference/dockerfile.md#healthcheck). ```yml healthcheck: diff --git a/content/compose/compose-file/11-extension.md b/content/compose/compose-file/11-extension.md index 3bde5cb72cc..7c38954aac5 100644 --- a/content/compose/compose-file/11-extension.md +++ b/content/compose/compose-file/11-extension.md @@ -6,6 +6,8 @@ keywords: compose, compose specification, extensions, compose file reference {{< include "compose/extension.md" >}} +Extensions can also be used with [anchors and aliases](10-fragments.md). + They also can be used within any structure in a Compose file where user-defined keys are not expected. Compose uses those to enable experimental features, the same way browsers add support for [custom CSS features](https://www.w3.org/TR/2011/REC-CSS2-20110607/syndata.html#vendor-keywords) diff --git a/content/includes/compose/extension.md b/content/includes/compose/extension.md index 3d59e2e4706..20b4ad6b616 100644 --- a/content/includes/compose/extension.md +++ b/content/includes/compose/extension.md @@ -1,4 +1,4 @@ -As with [Fragments](10-fragments.md), Extensions can be used to make your Compose file more efficient and easier to maintain. Extensions can also be used with [anchors and aliases](10-fragments.md). - +Extensions can be used to make your Compose file more efficient and easier to maintain. + Use the prefix `x-` as a top-level element to modularize configurations that you want to reuse. Compose ignores any fields that start with `x-`, this is the sole exception where Compose silently ignores unrecognized fields. \ No newline at end of file diff --git a/content/includes/compose/merge.md b/content/includes/compose/merge.md index 272fec10173..d413a203799 100644 --- a/content/includes/compose/merge.md +++ b/content/includes/compose/merge.md @@ -1,2 +1,2 @@ -Compose lets you define a Compose application model through [multiple Compose files](https://docs.docker.com/compose/multiple-compose-files/). +Compose lets you define a Compose application model through multiple Compose files. When doing so, Compose follows certain rules to merge Compose files. \ No newline at end of file diff --git a/content/includes/compose/services-healthcheck.md b/content/includes/compose/services-healthcheck.md index ff46585dea3..ce981ae1ae4 100644 --- a/content/includes/compose/services-healthcheck.md +++ b/content/includes/compose/services-healthcheck.md @@ -1,3 +1,2 @@ -The `healthcheck` attribute declares a check that's run to determine whether or not the service containers are "healthy". It works in the same way, and has the same default values, as the -[HEALTHCHECK Dockerfile instruction](https://docs.docker.com/reference/dockerfile/#healthcheck) +The `healthcheck` attribute declares a check that's run to determine whether or not the service containers are "healthy". It works in the same way, and has the same default values, as the HEALTHCHECK Dockerfile instruction set by the service's Docker image. Your Compose file can override the values set in the Dockerfile. \ No newline at end of file diff --git a/content/includes/compose/services-networks.md b/content/includes/compose/services-networks.md index 890af87113c..e7e431f1233 100644 --- a/content/includes/compose/services-networks.md +++ b/content/includes/compose/services-networks.md @@ -1,2 +1,2 @@ The `networks` attribute defines the networks that service containers are attached to, referencing entries under the -[`networks` top-level element](06-networks.md). The `networks` attribute helps manage the networking aspects of containers, providing control over how services are segmented and interact within the Docker environment. This is used to specify which networks the containers for that service should connect to. This is important for defining how containers communicate with each other and externally. \ No newline at end of file +`networks` top-level element. The `networks` attribute helps manage the networking aspects of containers, providing control over how services are segmented and interact within the Docker environment. This is used to specify which networks the containers for that service should connect to. This is important for defining how containers communicate with each other and externally. \ No newline at end of file diff --git a/content/includes/compose/services-secrets.md b/content/includes/compose/services-secrets.md index 7eca5f40fd5..5f7ddbcda81 100644 --- a/content/includes/compose/services-secrets.md +++ b/content/includes/compose/services-secrets.md @@ -1 +1 @@ -The `secrets` attribute grants access to sensitive data defined by the [secrets](09-secrets.md) top-level element on a per-service basis. Services can be granted access to multiple secrets. \ No newline at end of file +The `secrets` attribute grants access to sensitive data defined by the secrets top-level element on a per-service basis. Services can be granted access to multiple secrets. \ No newline at end of file diff --git a/content/includes/compose/services-volumes.md b/content/includes/compose/services-volumes.md index 0d973deff9a..465ace44023 100644 --- a/content/includes/compose/services-volumes.md +++ b/content/includes/compose/services-volumes.md @@ -2,4 +2,4 @@ The `volumes` attribute define mount host paths or named volumes that are access If the mount is a host path and is only used by a single service, it can be declared as part of the service definition. To reuse a volume across multiple services, a named -volume must be declared in the [top-level `volumes` key](07-volumes.md). \ No newline at end of file +volume must be declared in the `volumes` top-level element. \ No newline at end of file