diff --git a/roles/docker/README.rst b/roles/docker/README.rst index 8f8c44c..4747451 100644 --- a/roles/docker/README.rst +++ b/roles/docker/README.rst @@ -13,43 +13,47 @@ Role Variables Variables can be found in the `default vars `_ -.. codeblock:: 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" +.. 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. -.. codeblock:: yaml - docker_users: - - "syrell" +.. code-block:: yaml + + docker_users: + - "syrell" A list of UNIX users to add to the docker group. -.. codeblock:: yaml - docker_daemon_options: - docker_daemon_options: - log-opts: - max-size: "100m" +.. code-block:: yaml + + docker_daemon_options: + docker_daemon_options: + log-opts: + max-size: "100m" A dictionary listing options to add to the Docker daemon. -.. codeblock:: 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 }}" +.. 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. @@ -61,11 +65,12 @@ None. Example Playbook ---------------- -.. codeblock:: yaml - - name: Install docker - hosts: all - roles: - - docker +.. code-block:: yaml + + - name: Install docker + hosts: all + roles: + - docker License -------