Changed Docker role documentation to AsciiDoc

This commit is contained in:
syrell 2023-08-19 19:08:48 +02:00
parent 361cbbb8ff
commit 53fe119400
Signed by: syrell
GPG Key ID: BC9570E849334AF9
2 changed files with 81 additions and 83 deletions

81
roles/docker/README.adoc Normal file
View File

@ -0,0 +1,81 @@
= Docker setup
Docker setup Ansible role. This role is largely inspired by Jeff Geerling https://github.com/geerlingguy/ansible-role-docker[Docker role], I made my one since I tend to not rely on external projects too much especially when they are quite simple.
== Requirements
This role was written for Debian.
== Role Variables
Variables can be found in the link:./defaults/main.yml[default vars file].
[source,yaml]
----
docker_edition: 'ce'
docker_dependencies:
- "apt-transport-https"
- "ca-certificates"
- "curl"
- "gpg"
- "gnupg"
- "lsb-release"
docker_packages:
- "docker-{{ docker_edition }}"
- "docker-{{ docker_edition }}-cli"
- "docker-{{ docker_edition }}-rootless-extras"
- "containerd.io"
----
Defines Docker flavor to install, dependencies and the packages to install. We don't install the docker-compose binary since compose is include in the Docker command line.
[source,yaml]
----
docker_users:
- "syrell"
----
A list of UNIX users to add to the docker group.
[source,yaml]
----
docker_daemon_options:
docker_daemon_options:
log-opts:
max-size: "100m"
----
A dictionary containing options to add to the Docker daemon.
[source,yaml]
----
docker_apt_release_channel: stable
docker_repo_url: https://download.docker.com/linux
docker_apt_arch: amd64
docker_apt_gpg_key: "{{ docker_repo_url }}/{{ ansible_distribution | lower }}/gpg"
docker_apt_repository: "deb [arch={{ docker_apt_arch }}] {{ docker_repo_url }}/{{ ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}"
----
Variables relative to the Docker Debian repository.
== Dependencies
None.
== Example Playbook
[source,yaml]
----
- name: Install docker
hosts: all
roles:
- docker
----
== License
BSD-3
== Author Information
Role created by https://git.syyrell.com/syrell[syrell]

View File

@ -1,83 +0,0 @@
Docker setup
============
Docker setup Ansible role. This role is largely inspired by `Jeff Geerling <https://github.com/geerlingguy/ansible-role-docker>`_ Docker role, I made my one since I tend to not rely on external projects too much especially when they are quite simple.
Requirements
------------
This role was written for Debian.
Role Variables
--------------
Variables can be found in the `default vars <defaults/main.yml>`_
.. code-block:: yaml
docker_edition: 'ce'
docker_dependencies:
- "apt-transport-https"
- "ca-certificates"
- "curl"
- "gpg"
- "gnupg"
- "lsb-release"
docker_packages:
- "docker-{{ docker_edition }}"
- "docker-{{ docker_edition }}-cli"
- "docker-{{ docker_edition }}-rootless-extras"
- "containerd.io"
Defines Docker flavor to install, dependencies and the packages to install. We don't install the docker-compose binary since compose is include in the Docker command line.
.. code-block:: yaml
docker_users:
- "syrell"
A list of UNIX users to add to the docker group.
.. code-block:: yaml
docker_daemon_options:
docker_daemon_options:
log-opts:
max-size: "100m"
A dictionary listing options to add to the Docker daemon.
.. code-block:: yaml
docker_apt_release_channel: stable
docker_repo_url: https://download.docker.com/linux
docker_apt_arch: amd64
docker_apt_gpg_key: "{{ docker_repo_url }}/{{ ansible_distribution | lower }}/gpg"
docker_apt_repository: "deb [arch={{ docker_apt_arch }}] {{ docker_repo_url }}/{{ ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}"
Variables relative to the Docker Debian repository.
Dependencies
------------
None.
Example Playbook
----------------
.. code-block:: yaml
- name: Install docker
hosts: all
roles:
- docker
License
-------
BSD-3
Author Information
------------------
Role created by `syrell <https://git.syyrell.com/syrell>`_