From 53fe119400d75deea642942249212ce3a51614d6 Mon Sep 17 00:00:00 2001 From: syrell Date: Sat, 19 Aug 2023 19:08:48 +0200 Subject: [PATCH] Changed Docker role documentation to AsciiDoc --- roles/docker/README.adoc | 81 +++++++++++++++++++++++++++++++++++++++ roles/docker/README.rst | 83 ---------------------------------------- 2 files changed, 81 insertions(+), 83 deletions(-) create mode 100644 roles/docker/README.adoc delete mode 100644 roles/docker/README.rst diff --git a/roles/docker/README.adoc b/roles/docker/README.adoc new file mode 100644 index 0000000..45e4ca2 --- /dev/null +++ b/roles/docker/README.adoc @@ -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] diff --git a/roles/docker/README.rst b/roles/docker/README.rst deleted file mode 100644 index 4747451..0000000 --- a/roles/docker/README.rst +++ /dev/null @@ -1,83 +0,0 @@ -Docker setup -============ - -Docker setup Ansible role. This role is largely inspired by `Jeff Geerling `_ 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 `_ - -.. 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 `_