ENGDOCS-1166a (#16641)

This commit is contained in:
Allie Sadler 2023-01-31 15:27:52 +00:00 committed by GitHub
parent bed519e877
commit d165097c0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 32 additions and 0 deletions

6
_includes/compose-eol.md Normal file
View File

@ -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}

View File

@ -5,6 +5,7 @@ title: Compose file version 2 reference
toc_max: 4
toc_min: 1
---
{% include compose-eol.md %}
## Reference and guidelines

View File

@ -5,6 +5,7 @@ title: Compose file version 3 reference
toc_max: 4
toc_min: 1
---
{% include compose-eol.md %}
## Reference and guidelines

View File

@ -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

View File

@ -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.

View File

@ -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:

View File

@ -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, theres a precedence rule used by Compose. It aims to resolve the value for the variable in question.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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:

View File

@ -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?

View File

@ -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:

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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

View File

@ -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,

View File

@ -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.

View File

@ -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.

View File

@ -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

View File

@ -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)

View File

@ -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