docker(role): update README
Document Debian 12 support, enhance wording, bring structure in line with the READMEs of more modern roles and remove unnecessary sections.
This commit is contained in:
parent
d62c070ccc
commit
ce812fb006
1 changed files with 5 additions and 9 deletions
|
@ -1,26 +1,22 @@
|
||||||
# Role `docker`
|
# Role `docker`
|
||||||
|
|
||||||
Makes sure Docker Engine and other related packages are installed from the Docker repos on the specified hosts.
|
Ensures the Docker Engine and other related packages are installed from the Docker repos.
|
||||||
For details see: [`tasks/main/02_docker_install.yaml`](./tasks/main/02_docker_install.yaml).
|
For detailed list of packages see: [`tasks/main/02_docker_install.yaml`](./tasks/main/02_docker_install.yaml).
|
||||||
|
|
||||||
## Supported Distributions
|
## Supported Distributions
|
||||||
|
|
||||||
The following distributions are supported:
|
The following distributions are supported:
|
||||||
|
|
||||||
- Debian 11
|
- Debian 11
|
||||||
|
- Debian 12
|
||||||
|
|
||||||
## Required Arguments
|
## Required Arguments
|
||||||
|
|
||||||
None.
|
None.
|
||||||
|
|
||||||
## Updates
|
## Optional Arguments
|
||||||
|
|
||||||
This role doesn't handle updates.
|
None.
|
||||||
However it uses the system package manager for installing Docker Engine and the other related packages, so when you're making sure the system packages are up-to-date, you're handling updates for the packages installed by this role as well.
|
|
||||||
|
|
||||||
## `hosts`
|
|
||||||
|
|
||||||
The `hosts` for this role need to be the machines for which you want to make sure Docker Engine and other related packages are installed from the Docker repos.
|
|
||||||
|
|
||||||
## Links & Resources
|
## Links & Resources
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue