Skip to content

fixup: Add documentation for Compose service profiles #12191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2021
Merged

fixup: Add documentation for Compose service profiles #12191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
927ea24
Fix broken link in Compose service profiles page
acran Jan 27, 2021
6c64eec
Fix long line wrapping on Compose service profiles page
acran Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions compose/profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ keywords: cli, compose, profile, profiles reference

Profiles allow adjusting the Compose application model for various usages and
environments by selectively enabling services.
This is achieved by assigning each service to zero or more profiles. If unassigned, the service is _always_ started but if assigned, it is only started if the profile is activated.
This is achieved by assigning each service to zero or more profiles. If
unassigned, the service is _always_ started but if assigned, it is only started
if the profile is activated.

This allows one to define additional services in a single `docker-compose.yml` file
that should only be started in specific scenarios, e.g. for debugging or
Expand All @@ -15,8 +17,8 @@ development tasks.
## Assigning profiles to services

Services are associated with profiles through the
[`profiles` attribute](compose-file/index.md#profiles) which takes an array of
profile names:
[`profiles` attribute](compose-file/compose-file-v3.md#profiles) which takes an
array of profile names:

```yaml
version: "{{ site.compose_file_v3 }}"
Expand Down