docker_compose(role): move argument documentation to README
Do this to match newer roles and since reading documentation from argument_specs is quite unergonomic.
This commit is contained in:
parent
e390b7c202
commit
9f8d2d89cd
2 changed files with 8 additions and 12 deletions
|
|
@ -11,7 +11,14 @@ Should work on Debian-based distributions.
|
||||||
|
|
||||||
## Required Arguments
|
## Required Arguments
|
||||||
|
|
||||||
For the required arguments look at the [`argument_specs.yaml`](./meta/argument_specs.yaml).
|
- `docker_compose__compose_file_content`: The content to deploy to the Compose file at `/ansible_docker_compose/compose.yaml`.
|
||||||
|
|
||||||
|
## Optional Arguments
|
||||||
|
|
||||||
|
- `docker_compose__env_file_content`: The content to deploy to the `.env` file at `/ansible_docker_compose/.env`.
|
||||||
|
- `docker_compose__configuration_files`: A list of configuration files to deploy to the `/ansible_docker_compose/configs/` directory.
|
||||||
|
- `docker_compose__configuration_files.*.name`: The name of the configuration file.
|
||||||
|
- `docker_compose__configuration_files.*.content`: The content to deploy to the configuration file.
|
||||||
|
|
||||||
## Links & Resources
|
## Links & Resources
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,31 +2,20 @@ argument_specs:
|
||||||
main:
|
main:
|
||||||
options:
|
options:
|
||||||
docker_compose__compose_file_content:
|
docker_compose__compose_file_content:
|
||||||
description: >-
|
|
||||||
The content of the Compose file at
|
|
||||||
`/ansible_docker_compose/compose.yaml`.
|
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
docker_compose__env_file_content:
|
docker_compose__env_file_content:
|
||||||
description: >-
|
|
||||||
The content of the .env file at
|
|
||||||
`/ansible_docker_compose/.env`.
|
|
||||||
type: str
|
type: str
|
||||||
required: false
|
required: false
|
||||||
docker_compose__configuration_files:
|
docker_compose__configuration_files:
|
||||||
description: >-
|
|
||||||
A list of configuration files to be deployed in the
|
|
||||||
`/ansible_docker_compose/configs/` directory.
|
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
required: false
|
required: false
|
||||||
default: [ ]
|
default: [ ]
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The name of the configuration file.
|
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
description: The content of the configuration file.
|
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue