From d165097c0d199da99b1857951b1f82b11bcf5ce5 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Tue, 31 Jan 2023 15:27:52 +0000 Subject: [PATCH] ENGDOCS-1166a (#16641) --- _includes/compose-eol.md | 6 ++++++ compose/compose-file/compose-file-v2.md | 1 + compose/compose-file/compose-file-v3.md | 1 + compose/compose-file/index.md | 1 + compose/compose-v2/index.md | 1 + compose/environment-variables/env-file.md | 1 + compose/environment-variables/envvars-precedence.md | 1 + compose/environment-variables/envvars.md | 1 + compose/environment-variables/index.md | 1 + compose/environment-variables/set-environment-variables.md | 1 + compose/extends.md | 1 + compose/faq.md | 1 + compose/features-uses.md | 1 + compose/gettingstarted.md | 1 + compose/gpu-support.md | 1 + compose/index.md | 1 + compose/install/index.md | 1 + compose/install/linux.md | 1 + compose/install/other.md | 1 + compose/networking.md | 1 + compose/production.md | 1 + compose/profiles.md | 1 + compose/reference/index.md | 1 + compose/release-notes.md | 2 ++ compose/samples-for-compose.md | 1 + compose/startup-order.md | 1 + 26 files changed, 32 insertions(+) create mode 100644 _includes/compose-eol.md diff --git a/_includes/compose-eol.md b/_includes/compose-eol.md new file mode 100644 index 0000000000..eb740c5e8a --- /dev/null +++ b/_includes/compose-eol.md @@ -0,0 +1,6 @@ +> **Important** +> +> From the end of June 2023 Compose V1 won't be supported anymore and will be removed from all Docker Desktop versions. +> +> Make sure you switch to [Compose V2](/compose/compose-file/) with the `docker compose` CLI plugin or by activating the **Use Docker Compose V2** setting in Docker Desktop. For more information, see the [Evolution of Compose](/compose/compose-v2/) +{: .important} \ No newline at end of file diff --git a/compose/compose-file/compose-file-v2.md b/compose/compose-file/compose-file-v2.md index ae883826d4..c1a47fc3a3 100644 --- a/compose/compose-file/compose-file-v2.md +++ b/compose/compose-file/compose-file-v2.md @@ -5,6 +5,7 @@ title: Compose file version 2 reference toc_max: 4 toc_min: 1 --- +{% include compose-eol.md %} ## Reference and guidelines diff --git a/compose/compose-file/compose-file-v3.md b/compose/compose-file/compose-file-v3.md index fae833f574..c64d643094 100644 --- a/compose/compose-file/compose-file-v3.md +++ b/compose/compose-file/compose-file-v3.md @@ -5,6 +5,7 @@ title: Compose file version 3 reference toc_max: 4 toc_min: 1 --- +{% include compose-eol.md %} ## Reference and guidelines diff --git a/compose/compose-file/index.md b/compose/compose-file/index.md index a0b217c8b8..3432d25f75 100644 --- a/compose/compose-file/index.md +++ b/compose/compose-file/index.md @@ -8,6 +8,7 @@ title: Compose specification toc_max: 4 toc_min: 1 --- +{% include compose-eol.md %} The Compose file is a [YAML](https://yaml.org){: target="_blank" rel="noopener" class="_"} file defining services, networks, and volumes for a Docker application. The latest and recommended diff --git a/compose/compose-v2/index.md b/compose/compose-v2/index.md index 4894d5605b..1f2ea0e7d4 100644 --- a/compose/compose-v2/index.md +++ b/compose/compose-v2/index.md @@ -5,6 +5,7 @@ title: Evolution of Compose redirect_from: - /compose/cli-command-compatibility/ --- +{% include compose-eol.md %} This page provides information on the history of Compose and explains the key differences between Compose V1 and Compose V2. diff --git a/compose/environment-variables/env-file.md b/compose/environment-variables/env-file.md index dd9120d649..6c56645b5e 100644 --- a/compose/environment-variables/env-file.md +++ b/compose/environment-variables/env-file.md @@ -5,6 +5,7 @@ title: Use an environment file redirect_from: - /compose/env-file/ --- +{% include compose-eol.md %} ## Syntax The following syntax rules apply to environment files: diff --git a/compose/environment-variables/envvars-precedence.md b/compose/environment-variables/envvars-precedence.md index 1184bb589d..0f85be8dcc 100644 --- a/compose/environment-variables/envvars-precedence.md +++ b/compose/environment-variables/envvars-precedence.md @@ -5,6 +5,7 @@ keywords: compose, environment, env file redirect_from: - /compose/envvars-precedence/ --- +{% include compose-eol.md %} When you set the same environment variable in multiple sources, there’s a precedence rule used by Compose. It aims to resolve the value for the variable in question. diff --git a/compose/environment-variables/envvars.md b/compose/environment-variables/envvars.md index 5f3159c46a..cb36559344 100644 --- a/compose/environment-variables/envvars.md +++ b/compose/environment-variables/envvars.md @@ -5,6 +5,7 @@ title: Change pre-defined environment variables redirect_from: - /compose/reference/envvars/ --- +{% include compose-eol.md %} Compose already comes with pre-defined environment variables. diff --git a/compose/environment-variables/index.md b/compose/environment-variables/index.md index 4ef0d90081..8f1a92629e 100644 --- a/compose/environment-variables/index.md +++ b/compose/environment-variables/index.md @@ -3,6 +3,7 @@ title: Overview description: Explainer on the ways to set, use and manage environment variables in Compose keywords: compose, orchestration, environment, env file --- +{% include compose-eol.md %} Environment variables can help you define various configuration values. They also keep your app flexible and organized. diff --git a/compose/environment-variables/set-environment-variables.md b/compose/environment-variables/set-environment-variables.md index 2464208f22..9d76e0286b 100644 --- a/compose/environment-variables/set-environment-variables.md +++ b/compose/environment-variables/set-environment-variables.md @@ -6,6 +6,7 @@ redirect_from: - /compose/env/ - /compose/link-env-deprecated/ --- +{% include compose-eol.md %} Environment variables are dealt with by either the Compose file or the CLI. Both have multiple ways you can substitute in or set, your environment variables. This is outlined below. diff --git a/compose/extends.md b/compose/extends.md index 92e37169c7..7efdf0acfb 100644 --- a/compose/extends.md +++ b/compose/extends.md @@ -3,6 +3,7 @@ description: How to use Docker Compose's extends keyword to share configuration keywords: fig, composition, compose, docker, orchestration, documentation, docs title: Share Compose configurations between files and projects --- +{% include compose-eol.md %} Compose supports two methods of sharing common configuration: diff --git a/compose/faq.md b/compose/faq.md index 5394a025d2..473dc2c4d1 100644 --- a/compose/faq.md +++ b/compose/faq.md @@ -3,6 +3,7 @@ description: Docker Compose FAQ keywords: documentation, docs, docker, compose, faq title: Frequently asked questions --- +{% include compose-eol.md %} ## How do I get help? diff --git a/compose/features-uses.md b/compose/features-uses.md index 0e0918b6f0..2aa023ba63 100644 --- a/compose/features-uses.md +++ b/compose/features-uses.md @@ -3,6 +3,7 @@ description: Key features and use cases of Docker Compose keywords: documentation, docs, docker, compose, orchestration, containers, uses, features title: Key features and use cases --- +{% include compose-eol.md %} Using Compose is essentially a three-step process: diff --git a/compose/gettingstarted.md b/compose/gettingstarted.md index d879c60aa5..5255c76bac 100644 --- a/compose/gettingstarted.md +++ b/compose/gettingstarted.md @@ -3,6 +3,7 @@ description: Get started with Docker Compose keywords: documentation, docs, docker, compose, orchestration, containers title: Try Docker Compose --- +{% include compose-eol.md %} This tutorial is designed to introduce the key concepts of Docker Compose whilst building a simple Python web application. The application uses the Flask framework and maintains a hit counter in Redis. diff --git a/compose/gpu-support.md b/compose/gpu-support.md index efb4f33334..e1e6af207c 100644 --- a/compose/gpu-support.md +++ b/compose/gpu-support.md @@ -3,6 +3,7 @@ description: GPU support in Compose keywords: documentation, docs, docker, compose, GPU access, NVIDIA, samples title: Enabling GPU access with Compose --- +{% include compose-eol.md %} Compose services can define GPU device reservations if the Docker host contains such devices and the Docker Daemon is set accordingly. For this, make sure you install the [prerequisites](../config/containers/resource_constraints.md#gpu){: target="_blank" rel="noopener" class="_" } if you have not already done so. diff --git a/compose/index.md b/compose/index.md index 4ec92ce014..e4474c6917 100644 --- a/compose/index.md +++ b/compose/index.md @@ -9,6 +9,7 @@ redirect_from: - /compose/swarm/ - /compose/completion/ --- +{% include compose-eol.md %} Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application's services. diff --git a/compose/install/index.md b/compose/install/index.md index 7601a8a94d..4d4282fcbc 100644 --- a/compose/install/index.md +++ b/compose/install/index.md @@ -6,6 +6,7 @@ toc_max: 3 redirect_from: - /compose/compose-desktop/ --- +{% include compose-eol.md %} This page contains summary information about the available options for getting Docker Compose. diff --git a/compose/install/linux.md b/compose/install/linux.md index fa37c2a78c..a7a738de20 100644 --- a/compose/install/linux.md +++ b/compose/install/linux.md @@ -7,6 +7,7 @@ redirect_from: - /compose/compose-plugin/ - /compose/compose-linux/ --- +{% include compose-eol.md %} On this page you can find instructions on how to install the Compose plugin on Linux from the command line. diff --git a/compose/install/other.md b/compose/install/other.md index d3c38aaf93..fedc94b4e5 100644 --- a/compose/install/other.md +++ b/compose/install/other.md @@ -4,6 +4,7 @@ keywords: compose, orchestration, install, installation, docker, documentation toc_max: 3 title: Install the Compose standalone --- +{% include compose-eol.md %} On this page you can find instructions on how to install the Compose standalone on Linux or Windows Server, from the command line. diff --git a/compose/networking.md b/compose/networking.md index 39b621c652..6f9bec931c 100644 --- a/compose/networking.md +++ b/compose/networking.md @@ -3,6 +3,7 @@ description: How Compose sets up networking between containers keywords: documentation, docs, docker, compose, orchestration, containers, networking title: Networking in Compose --- +{% include compose-eol.md %} By default Compose sets up a single [network](../engine/reference/commandline/network_create.md){: target="_blank" rel="noopener" class="_" } for your app. Each diff --git a/compose/production.md b/compose/production.md index 85e3def619..7f4d9597c8 100644 --- a/compose/production.md +++ b/compose/production.md @@ -3,6 +3,7 @@ description: Guide to using Docker Compose in production keywords: compose, orchestration, containers, production title: Use Compose in production --- +{% include compose-eol.md %} When you define your app with Compose in development, you can use this definition to run your application in different environments such as CI, diff --git a/compose/profiles.md b/compose/profiles.md index 69b732e6e3..c9facabb85 100644 --- a/compose/profiles.md +++ b/compose/profiles.md @@ -3,6 +3,7 @@ title: Using profiles with Compose desription: Using profiles with Compose keywords: cli, compose, profile, profiles reference --- +{% include compose-eol.md %} Profiles help you adjust the Compose application model for various uses and environments by selectively enabling services. diff --git a/compose/reference/index.md b/compose/reference/index.md index 25fd1b2bbb..d08ee0281e 100644 --- a/compose/reference/index.md +++ b/compose/reference/index.md @@ -5,6 +5,7 @@ redirect_from: - /compose/reference/overview/ title: Overview of docker compose CLI --- +{% include compose-eol.md %} This page provides the usage information for the `docker compose` Command. diff --git a/compose/release-notes.md b/compose/release-notes.md index 9f3f88446c..2885198263 100644 --- a/compose/release-notes.md +++ b/compose/release-notes.md @@ -6,6 +6,8 @@ toc_max: 2 redirect_from: - /release-notes/docker-compose/ --- +{% include compose-eol.md %} + ## 2.15.1 {% include release-date.html date="2023-01-09" %} ### Update diff --git a/compose/samples-for-compose.md b/compose/samples-for-compose.md index 564935bbda..09996d5448 100644 --- a/compose/samples-for-compose.md +++ b/compose/samples-for-compose.md @@ -3,6 +3,7 @@ description: Summary of samples related to Compose keywords: documentation, docs, docker, compose, samples title: Sample apps with Compose --- +{% include compose-eol.md %} The following samples show the various aspects of how to work with Docker Compose. As a prerequisite, be sure to [install Docker Compose](install/index.md) diff --git a/compose/startup-order.md b/compose/startup-order.md index 10e9dd08a0..087ff65900 100644 --- a/compose/startup-order.md +++ b/compose/startup-order.md @@ -4,6 +4,7 @@ keywords: documentation, docs, docker, compose, startup, shutdown, order title: Control startup and shutdown order in Compose notoc: true --- +{% include compose-eol.md %} You can control the order of service startup and shutdown with the [depends_on](compose-file/index.md#depends_on) option. Compose always starts and stops