diff --git a/README.md b/README.md index fa086d5..0488985 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Ansible Collection: ericsysmin.docker -[![Build Status](https://travis-ci.com/ericsysmin/ansible-collection-docker.svg?branch=master)](https://travis-ci.com/ericsysmin/ansible-collection-docker) - ## Role Summary This role provides the following: @@ -24,80 +22,7 @@ Supports the following Operating Systems: ## Requirements -This role requires Ansible 2.4 or higher. Requirements are listed in the metadata file. - -## Role Variables - -For more information about the variables many can be found - -| Variable | Required | Default | Comments | -| ------------------------------------- | -------- | ----------- | --------------------------------------------------------------------------------------------- | -| `docker_edition` | No | `ce` | Specifies either ce, or ee version of Docker. | -| `docker_ee_url` | No | `Undefined` | Docker EE URL from the Docker Store | -| `docker_repo` | No | `docker` | Defines how Ansible manages the repository. Options are "other" and "docker" | -| `docker_channel` | No | `stable` | What release channel of Docker to install. | -| `docker_ee_version` | No | `17.03` | Docker EE version for EE repository | -| `docker_storage_driver` | No | `Undefined` | Storage driver to use | -| `docker_block_device` | No | `Undefined` | The device name used for the storage driver. | -| `docker_mount_opts` | No | `Undefined` | The mount options when mounting filesystems | -| `docker_storage_opts` | No | `Undefined` | Storage driver options | -| `docker_api_cors_header` | No | `Undefined` | Set CORS headers in the remote API | -| `docker_authorization_plugins` | No | `Undefined` | Authorization plugins to load | -| `docker_bip` | No | `Undefined` | Specify network bridge IP | -| `docker_bridge` | No | `Undefined` | Attach containers to a network bridge | -| `docker_cgroup_parent` | No | `Undefined` | Set parent cgroup for all containers | -| `docker_cluster_store` | No | `Undefined` | Set cluster store options | -| `docker_cluster_store_opts` | No | `Undefined` | Please see dockerd manual for info | -| `docker_cluster_advertise` | No | `Undefined` | Address or interface name to advertise | -| `docker_debug` | No | `Undefined` | Enable debug mode | -| `docker_default_gateway` | No | `Undefined` | Container default gateway IPv4 address | -| `docker_default_gateway_v6` | No | `Undefined` | Container default gateway IPv6 address | -| `docker_default_runtime` | No | `Undefined` | Default OCI runtime for containers | -| `docker_default_ulimits` | No | `Undefined` | Default ulimits for containers | -| `docker_disable_legacy_registry` | No | `Undefined` | Disable contacting legacy registries | -| `docker_dns` | No | `Undefined` | DNS server to use | -| `docker_dns_opts` | No | `Undefined` | DNS options to use | -| `docker_dns_search` | No | `Undefined` | DNS search domains to use | -| `docker_exec_opts` | No | `Undefined` | Runtime execution options | -| `docker_exec_root` | No | `Undefined` | Root directory for execution state files | -| `docker_fixed_cidr` | No | `Undefined` | IPv4 subnet for fixed IPs | -| `docker_fixed_cidr_v6` | No | `Undefined` | IPv6 subnet for fixed IPs | -| `docker_graph` | No | `Undefined` | Root of the Docker runtime | -| `docker_group` | No | `Undefined` | Group for the unix socket | -| `docker_hosts` | No | `Undefined` | Daemon socket(s) to connect to | -| `docker_icc` | No | `Undefined` | Enable inter-container communication | -| `docker_insecure_registries` | No | `Undefined` | Enable insecure registry communication | -| `docker_ip` | No | `Undefined` | Default IP when binding container ports | -| `docker_iptables` | No | `Undefined` | Enable addition of iptables rules | -| `docker_ipv6` | No | `Undefined` | Enable IPv6 networking | -| `docker_ip_forward` | No | `Undefined` | Enable net.ipv4.ip_forward | -| `docker_ip_masq` | No | `Undefined` | Enable IP masquerading | -| `docker_labels` | No | `Undefined` | Set key=value labels to the daemon | -| `docker_live_restore` | No | `Undefined` | Enables keeping containers alive during daemon downtime | -| `docker_log_driver` | No | `Undefined` | Default driver for container logs | -| `docker_log_level` | No | `Undefined` | Set the logging level | -| `docker_log_opts` | No | `Undefined` | Default log driver options for containers | -| `docker_max_concurrent_downloads` | No | `Undefined` | Set the max concurrent downloads for each pull | -| `docker_max_concurrent_uploads` | No | `Undefined` | Set the max concurrent uploads for each push | -| `docker_mtu` | No | `Undefined` | Set the containers network MTU | -| `docker_oom_score_adjust` | No | `Undefined` | Set the oom_score_adj for the daemon | -| `docker_pidfile` | No | `Undefined` | Path to use for daemon PID file | -| `docker_raw_logs` | No | `Undefined` | Full timestamps without ANSI coloring | -| `docker_registry_mirrors` | No | `Undefined` | Preferred Docker registry mirror | -| `docker_runtimes` | No | `Undefined` | Register an additional OCI compatible runtime | -| `docker_selinux_enabled` | No | `Undefined` | Enable selinux support | -| `docker_swarm_default_advertise_addr` | No | `Undefined` | Set default address or interface for swarm advertised address | -| `docker_tls` | No | `Undefined` | Use TLS; implied by –tlsverify | -| `docker_tlscacert` | No | `Undefined` | Trust certs signed only by this CA | -| `docker_tlscert` | No | `Undefined` | Path to TLS certificate file | -| `docker_tlskey` | No | `Undefined` | Path to TLS key file | -| `docker_tlsverify` | No | `Undefined` | Use TLS and verify the remote | -| `docker_userland_proxy` | No | `Undefined` | Use userland proxy for loopback traffic | -| `docker_userns_remap` | No | `Undefined` | User/Group setting for user namespaces | -| `docker_users` | No | `Undefined` | A list of system users to be added to the docker group (so they can use Docker on the server) | -| `docker_http_proxy` | No | `Undefined` | Set the Docker service to use HTTP_PROXY | -| `docker_https_proxy` | No | `Undefined` | Set the Docker service to use HTTPS_PROXY | -| `docker_no_proxy_params` | No | `Undefined` | Do not proxy for Docker service params | +This role requires Ansible 2.9 or higher. Requirements are listed in the metadata file. ## Example Playbooks diff --git a/changelogs/config.yaml b/changelogs/config.yaml new file mode 100644 index 0000000..a053f29 --- /dev/null +++ b/changelogs/config.yaml @@ -0,0 +1,32 @@ +changelog_filename_template: ../CHANGELOG.rst +changelog_filename_version_depth: 0 +changes_file: changelog.yaml +changes_format: combined +ignore_other_fragment_extensions: true +keep_fragments: false +mention_ancestor: true +new_plugins_after_name: removed_features +notesdir: fragments +prelude_section_name: release_summary +prelude_section_title: Release Summary +sanitize_changelog: true +sections: +- - major_changes + - Major Changes +- - minor_changes + - Minor Changes +- - breaking_changes + - Breaking Changes / Porting Guide +- - deprecated_features + - Deprecated Features +- - removed_features + - Removed Features (previously deprecated) +- - security_fixes + - Security Fixes +- - bugfixes + - Bugfixes +- - known_issues + - Known Issues +title: Ericsysmin.Docker +trivial_section_name: trivial +use_fqcn: true diff --git a/dest/.gitignore b/dest/.gitignore new file mode 100644 index 0000000..0a39f3e --- /dev/null +++ b/dest/.gitignore @@ -0,0 +1,8 @@ +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Created with antsibull-docs 2.6.1 + +/temp-rst +/build diff --git a/dest/antsibull-docs.cfg b/dest/antsibull-docs.cfg new file mode 100644 index 0000000..19c644d --- /dev/null +++ b/dest/antsibull-docs.cfg @@ -0,0 +1,24 @@ +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Created with antsibull-docs 2.6.1 + +breadcrumbs = true +indexes = true +use_html_blobs = false + +# You can specify ways to convert a collection name (.) to an URL here. +# You can replace either of or by "*" to match all values in that place, +# or use "*" for the collection name to match all collections. In the URL, you can use +# {namespace} and {name} for the two components of the collection name. If you want to use +# "{" or "}" in the URL, write "{{" or "}}" instead. Basically these are Python format +# strings (https://docs.python.org/3.8/library/string.html#formatstrings). +collection_url = { + * = "https://galaxy.ansible.com/ui/repo/published/{namespace}/{name}/" +} + +# The same wildcard rules and formatting rules as for collection_url apply. +collection_install = { + * = "ansible-galaxy collection install {namespace}.{name}" +} diff --git a/dest/build.sh b/dest/build.sh new file mode 100755 index 0000000..68e2b0a --- /dev/null +++ b/dest/build.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Created with antsibull-docs 2.6.1 + +set -e + +pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" +trap "{ popd; }" EXIT + +# Create collection documentation into temporary directory +rm -rf temp-rst +mkdir -p temp-rst +chmod og-w temp-rst # antsibull-docs wants that directory only readable by itself +antsibull-docs \ + --config-file antsibull-docs.cfg \ + collection \ + --use-current \ + --dest-dir temp-rst \ + ericsysmin.docker + +# Copy collection documentation into source directory +rsync -cprv --delete-after temp-rst/collections/ rst/collections/ + +# Build Sphinx site +sphinx-build -M html rst build -c . -W --keep-going + diff --git a/dest/conf.py b/dest/conf.py new file mode 100644 index 0000000..21cfbb3 --- /dev/null +++ b/dest/conf.py @@ -0,0 +1,46 @@ +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Created with antsibull-docs 2.6.1 + +# This file only contains a selection of the most common options. For a full list see the +# documentation: +# http://www.sphinx-doc.org/en/master/config + +project = 'Ansible collections' +copyright = 'Ansible contributors' + +title = 'Ansible Collections Documentation' +html_short_title = 'Ansible Collections Documentation' + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx_antsibull_ext'] + +pygments_style = 'ansible' + +highlight_language = 'YAML+Jinja' + +html_theme = 'sphinx_ansible_theme' +html_show_sphinx = False + +display_version = False + +html_use_smartypants = True +html_use_modindex = False +html_use_index = False +html_copy_source = False + +# See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping for the syntax +intersphinx_mapping = { + 'python': ('https://docs.python.org/2/', (None, '../python2.inv')), + 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), + 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), + 'ansible_devel': ('https://docs.ansible.com/ansible/devel/', (None, '../ansible_devel.inv')), + # If you want references to resolve to a released Ansible version (say, `5`), uncomment and replace X by this version: + # 'ansibleX': ('https://docs.ansible.com/ansible/X/', (None, '../ansibleX.inv')), +} + +default_role = 'any' + +nitpicky = True + diff --git a/dest/requirements.txt b/dest/requirements.txt new file mode 100644 index 0000000..a369438 --- /dev/null +++ b/dest/requirements.txt @@ -0,0 +1,10 @@ +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Created with antsibull-docs 2.6.1 + +antsibull-docs >= 2.0.0, < 3.0.0 +ansible-pygments +sphinx +sphinx-ansible-theme >= 0.9.0 diff --git a/dest/rst/collections/environment_variables.rst b/dest/rst/collections/environment_variables.rst new file mode 100644 index 0000000..e7b9060 --- /dev/null +++ b/dest/rst/collections/environment_variables.rst @@ -0,0 +1,15 @@ + +:orphan: + +.. meta:: + :antsibull-docs: 2.6.1 + +.. _list_of_collection_env_vars: + +Index of all Collection Environment Variables +============================================= + +The following index documents all environment variables declared by plugins in collections. +Environment variables used by the ansible-core configuration are documented in :ref:`ansible_configuration_settings`. + +No environment variables have been defined. diff --git a/dest/rst/collections/ericsysmin/docker/docker_role.rst b/dest/rst/collections/ericsysmin/docker/docker_role.rst new file mode 100644 index 0000000..630255d --- /dev/null +++ b/dest/rst/collections/ericsysmin/docker/docker_role.rst @@ -0,0 +1,2569 @@ + +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.6.1 + +.. Anchors + +.. _ansible_collections.ericsysmin.docker.docker_role: + +.. Title + +ericsysmin.docker.docker role -- Ansible role to install and configure Docker ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This role is part of the `ericsysmin.docker collection `_ (version 1.0.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it use: :code:`ansible-galaxy collection install ericsysmin.docker`. + + To use it in a playbook, specify: :code:`ericsysmin.docker.docker`. + +.. contents:: + :local: + :depth: 2 + + +.. Entry point title + +Entry point ``main`` -- Ansible role to install and configure Docker +-------------------------------------------------------------------- + +.. version_added + + +.. Deprecated + + +Synopsis +^^^^^^^^ + +.. Description + +- Installation of Docker following Docker-Engine install procedures as documented by Docker. +- It will manage kernel versions as well, verifying the that the correct kernel for Docker support is installed. + +.. Requirements + + +.. Options + +Parameters +^^^^^^^^^^ + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_api_cors_header: + + .. rst-class:: ansible-option-title + + **docker_api_cors_header** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set CORS headers in the remote API + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_authorization_plugins: + + .. rst-class:: ansible-option-title + + **docker_authorization_plugins** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Authorization plugins to load + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_bip: + + .. rst-class:: ansible-option-title + + **docker_bip** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specify network bridge IP + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_block_device: + + .. rst-class:: ansible-option-title + + **docker_block_device** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device name used for the storage driver. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_bridge: + + .. rst-class:: ansible-option-title + + **docker_bridge** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Attach containers to a network bridge + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_cgroup_parent: + + .. rst-class:: ansible-option-title + + **docker_cgroup_parent** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set parent cgroup for all containers + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_channel: + + .. rst-class:: ansible-option-title + + **docker_channel** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + What release channel of Docker to install. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"stable"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_cluster_advertise: + + .. rst-class:: ansible-option-title + + **docker_cluster_advertise** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Address or interface name to advertise + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_cluster_store: + + .. rst-class:: ansible-option-title + + **docker_cluster_store** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set cluster store options + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_cluster_store_opts: + + .. rst-class:: ansible-option-title + + **docker_cluster_store_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Please see dockerd manual for info + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_debug: + + .. rst-class:: ansible-option-title + + **docker_debug** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable debug mode + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_default_gateway: + + .. rst-class:: ansible-option-title + + **docker_default_gateway** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Container default gateway IPv4 address + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_default_gateway_v6: + + .. rst-class:: ansible-option-title + + **docker_default_gateway_v6** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Container default gateway IPv6 address + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_default_runtime: + + .. rst-class:: ansible-option-title + + **docker_default_runtime** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Default OCI runtime for containers + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_default_ulimits: + + .. rst-class:: ansible-option-title + + **docker_default_ulimits** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Default ulimits for containers + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_disable_legacy_registry: + + .. rst-class:: ansible-option-title + + **docker_disable_legacy_registry** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Disable contacting legacy registries + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_dns: + + .. rst-class:: ansible-option-title + + **docker_dns** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + DNS server to use + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_dns_opts: + + .. rst-class:: ansible-option-title + + **docker_dns_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + DNS options to use + + + .. raw:: html + +
+ + * - .. raw:: html + +
+ + + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_dns_search: + + .. rst-class:: ansible-option-title + + **docker_dns_search** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + DNS search domains to use + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_edition: + + .. rst-class:: ansible-option-title + + **docker_edition** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies either ce, or ee version of Docker. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"ce"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ee_url: + + .. rst-class:: ansible-option-title + + **docker_ee_url** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Docker EE URL from the Docker Store + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ee_version: + + .. rst-class:: ansible-option-title + + **docker_ee_version** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Docker EE version for EE repository + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`17.03` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_exec_opts: + + .. rst-class:: ansible-option-title + + **docker_exec_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Runtime execution options + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_exec_root: + + .. rst-class:: ansible-option-title + + **docker_exec_root** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Root directory for execution state files + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_fixed_cidr: + + .. rst-class:: ansible-option-title + + **docker_fixed_cidr** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + IPv4 subnet for fixed IPs + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_fixed_cidr_v6: + + .. rst-class:: ansible-option-title + + **docker_fixed_cidr_v6** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + IPv6 subnet for fixed IPs + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_graph: + + .. rst-class:: ansible-option-title + + **docker_graph** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Root of the Docker runtime + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_group: + + .. rst-class:: ansible-option-title + + **docker_group** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Group for the unix socket + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_hosts: + + .. rst-class:: ansible-option-title + + **docker_hosts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Daemon socket(s) to connect to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_http_proxy: + + .. rst-class:: ansible-option-title + + **docker_http_proxy** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the Docker service to use HTTP\_PROXY + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_https_proxy: + + .. rst-class:: ansible-option-title + + **docker_https_proxy** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the Docker service to use HTTPS\_PROXY + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_icc: + + .. rst-class:: ansible-option-title + + **docker_icc** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable inter-container communication + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_insecure_registries: + + .. rst-class:: ansible-option-title + + **docker_insecure_registries** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable insecure registry communication + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ip: + + .. rst-class:: ansible-option-title + + **docker_ip** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Default IP when binding container ports + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ip_forward: + + .. rst-class:: ansible-option-title + + **docker_ip_forward** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable net.ipv4.ip\_forward + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ip_masq: + + .. rst-class:: ansible-option-title + + **docker_ip_masq** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable IP masquerading + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_iptables: + + .. rst-class:: ansible-option-title + + **docker_iptables** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable addition of iptables rules + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_ipv6: + + .. rst-class:: ansible-option-title + + **docker_ipv6** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable IPv6 networking + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_labels: + + .. rst-class:: ansible-option-title + + **docker_labels** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set key=value labels to the daemon + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_live_restore: + + .. rst-class:: ansible-option-title + + **docker_live_restore** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enables keeping containers alive during daemon downtime + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_log_driver: + + .. rst-class:: ansible-option-title + + **docker_log_driver** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Default driver for container logs + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_log_level: + + .. rst-class:: ansible-option-title + + **docker_log_level** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the logging level + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_log_opts: + + .. rst-class:: ansible-option-title + + **docker_log_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Default log driver options for containers + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_max_concurrent_downloads: + + .. rst-class:: ansible-option-title + + **docker_max_concurrent_downloads** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the max concurrent downloads for each pull + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_max_concurrent_uploads: + + .. rst-class:: ansible-option-title + + **docker_max_concurrent_uploads** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the max concurrent uploads for each push + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_mount_opts: + + .. rst-class:: ansible-option-title + + **docker_mount_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The mount options when mounting filesystems + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_mtu: + + .. rst-class:: ansible-option-title + + **docker_mtu** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the containers network MTU + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_no_proxy_params: + + .. rst-class:: ansible-option-title + + **docker_no_proxy_params** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Do not proxy for Docker service params + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_oom_score_adjust: + + .. rst-class:: ansible-option-title + + **docker_oom_score_adjust** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the oom\_score\_adj for the daemon + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_pidfile: + + .. rst-class:: ansible-option-title + + **docker_pidfile** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Path to use for daemon PID file + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_raw_logs: + + .. rst-class:: ansible-option-title + + **docker_raw_logs** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Full timestamps without ANSI coloring + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_registry_mirrors: + + .. rst-class:: ansible-option-title + + **docker_registry_mirrors** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Preferred Docker registry mirror + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_repo: + + .. rst-class:: ansible-option-title + + **docker_repo** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Defines how Ansible manages the repository + + Options are \ :literal:`other`\ and \ :literal:`docker`\ + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"docker"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_runtimes: + + .. rst-class:: ansible-option-title + + **docker_runtimes** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Register an additional OCI compatible runtime + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_selinux_enabled: + + .. rst-class:: ansible-option-title + + **docker_selinux_enabled** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Enable selinux support + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_storage_driver: + + .. rst-class:: ansible-option-title + + **docker_storage_driver** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Storage driver to use + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_storage_opts: + + .. rst-class:: ansible-option-title + + **docker_storage_opts** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Storage driver options + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_swarm_default_advertise_addr: + + .. rst-class:: ansible-option-title + + **docker_swarm_default_advertise_addr** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set default address or interface for swarm advertised address + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_tls: + + .. rst-class:: ansible-option-title + + **docker_tls** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use TLS; implied by –tlsverify + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_tlscacert: + + .. rst-class:: ansible-option-title + + **docker_tlscacert** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Trust certs signed only by this CA + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_tlscert: + + .. rst-class:: ansible-option-title + + **docker_tlscert** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Path to TLS certificate file + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_tlskey: + + .. rst-class:: ansible-option-title + + **docker_tlskey** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Path to TLS key file + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_tlsverify: + + .. rst-class:: ansible-option-title + + **docker_tlsverify** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use TLS and verify the remote + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_userland_proxy: + + .. rst-class:: ansible-option-title + + **docker_userland_proxy** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use userland proxy for loopback traffic + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_userns_remap: + + .. rst-class:: ansible-option-title + + **docker_userns_remap** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + User/Group setting for user namespaces + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ericsysmin.docker.docker_role__parameter-main__docker_users: + + .. rst-class:: ansible-option-title + + **docker_users** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A list of system users to be added to the docker group (so they can use Docker on the server) + + + .. raw:: html + +
+ + +.. Attributes + + +.. Notes + + +.. Seealso + + +Authors +^^^^^^^ + +- Eric Anderson + + + +.. Extra links + +Collection links +~~~~~~~~~~~~~~~~ + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/ericsysmin/ansible-collection-docker/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/ericsysmin/ansible-collection-docker" + external: true + + +.. Parsing errors + diff --git a/dest/rst/collections/ericsysmin/docker/index.rst b/dest/rst/collections/ericsysmin/docker/index.rst new file mode 100644 index 0000000..10aee54 --- /dev/null +++ b/dest/rst/collections/ericsysmin/docker/index.rst @@ -0,0 +1,66 @@ + + +.. meta:: + :antsibull-docs: 2.6.1 + + +.. _plugins_in_ericsysmin.docker: + +Ericsysmin.Docker +================= + +Collection version 1.0.0 + +.. contents:: + :local: + :depth: 1 + +Description +----------- + +Docker collection + +**Author:** + +* Eric Anderson + + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/ericsysmin/ansible-collection-docker/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/ericsysmin/ansible-collection-docker" + external: true + + + + +.. toctree:: + :maxdepth: 1 + + +Plugin Index +------------ + +There are no plugins in the ericsysmin.docker collection with automatically generated documentation. + + +Role Index +---------- + +These are the roles in the ericsysmin.docker collection: + +* :ansplugin:`docker role ` -- Ansible role to install and configure Docker + +.. toctree:: + :maxdepth: 1 + :hidden: + + docker_role + + +.. seealso:: + + List of :ref:`collections ` with docs hosted here. diff --git a/dest/rst/collections/ericsysmin/index.rst b/dest/rst/collections/ericsysmin/index.rst new file mode 100644 index 0000000..1280370 --- /dev/null +++ b/dest/rst/collections/ericsysmin/index.rst @@ -0,0 +1,19 @@ + + +.. meta:: + :antsibull-docs: 2.6.1 + +.. _list_of_collections_ericsysmin: + +Collections in the Ericsysmin Namespace +======================================= + +These are the collections documented here in the **ericsysmin** namespace. + +* :ref:`ericsysmin.docker ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + docker/index diff --git a/dest/rst/collections/index.rst b/dest/rst/collections/index.rst new file mode 100644 index 0000000..35ba198 --- /dev/null +++ b/dest/rst/collections/index.rst @@ -0,0 +1,20 @@ + +:orphan: + +.. meta:: + :antsibull-docs: 2.6.1 + +.. _list_of_collections: + +Collection Index +================ + +These are the collections documented here. + +* :ref:`ericsysmin.docker ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + ericsysmin/index diff --git a/dest/rst/collections/index_role.rst b/dest/rst/collections/index_role.rst new file mode 100644 index 0000000..1e3d294 --- /dev/null +++ b/dest/rst/collections/index_role.rst @@ -0,0 +1,16 @@ + +:orphan: + +.. meta:: + :antsibull-docs: 2.6.1 + +.. _list_of_role_plugins: + +Index of all Roles +================== + +ericsysmin.docker +----------------- + +* :ansplugin:`ericsysmin.docker.docker#role` -- Ansible role to install and configure Docker + diff --git a/dest/rst/index.rst b/dest/rst/index.rst new file mode 100644 index 0000000..a180d9a --- /dev/null +++ b/dest/rst/index.rst @@ -0,0 +1,31 @@ + +.. Created with antsibull-docs 2.6.1 + +.. _docsite_root_index: + +Welcome to my Ansible collection documentation +============================================== + +This docsite contains documentation of ericsysmin.docker. + + +.. toctree:: + :maxdepth: 2 + :caption: Collections: + + collections/index + + +.. toctree:: + :maxdepth: 1 + :caption: Plugin indexes: + :glob: + + collections/index_* + + +.. toctree:: + :maxdepth: 1 + :caption: Reference indexes: + + collections/environment_variables diff --git a/roles/docker/meta/argument_specs.yml b/roles/docker/meta/argument_specs.yml new file mode 100644 index 0000000..9514e14 --- /dev/null +++ b/roles/docker/meta/argument_specs.yml @@ -0,0 +1,149 @@ +--- +# code: language=ansible +argument_specs: + main: + short_description: Ansible role to install and configure Docker + description: + - Installation of Docker following Docker-Engine install procedures as documented by Docker. + - It will manage kernel versions as well, verifying the that the correct kernel for Docker support is installed. + author: + - Eric Anderson + options: + docker_edition: + description: Specifies either ce, or ee edition of Docker. + default: ce + docker_ee_url: + description: Docker EE URL from the Docker Store + docker_repo: + description: + - Defines how Ansible manages the repository + - Options are C(other) and C(docker) + default: docker + docker_channel: + description: What release channel of Docker to install. + default: stable + docker_ee_version: + description: Docker EE version for EE repository + default: 17.03 + docker_storage_driver: + description: Storage driver to use + docker_block_device: + description: The device name used for the storage driver. + docker_mount_opts: + description: The mount options when mounting filesystems + docker_storage_opts: + description: Storage driver options + docker_api_cors_header: + description: Set CORS headers in the remote API + docker_authorization_plugins: + description: Authorization plugins to load + docker_bip: + description: Specify network bridge IP + docker_bridge: + description: Attach containers to a network bridge + docker_cgroup_parent: + description: Set parent cgroup for all containers + docker_cluster_store: + description: Set cluster store options + docker_cluster_store_opts: + description: Please see dockerd manual for info + docker_cluster_advertise: + description: Address or interface name to advertise + docker_debug: + description: Enable debug mode + docker_default_gateway: + description: Container default gateway IPv4 address + docker_default_gateway_v6: + description: Container default gateway IPv6 address + docker_default_runtime: + description: Default OCI runtime for containers + docker_default_ulimits: + description: Default ulimits for containers + docker_disable_legacy_registry: + description: Disable contacting legacy registries + docker_dns: + description: DNS server to use + docker_dns_opts: + description: DNS options to use + docker_dns_search: + description: DNS search domains to use + docker_exec_opts: + description: Runtime execution options + docker_exec_root: + description: Root directory for execution state files + docker_fixed_cidr: + description: IPv4 subnet for fixed IPs + docker_fixed_cidr_v6: + description: IPv6 subnet for fixed IPs + docker_graph: + description: Root of the Docker runtime + docker_group: + description: Group for the unix socket + docker_hosts: + description: Daemon socket(s) to connect to + docker_icc: + description: Enable inter-container communication + docker_insecure_registries: + description: Enable insecure registry communication + docker_ip: + description: Default IP when binding container ports + docker_iptables: + description: Enable addition of iptables rules + docker_ipv6: + description: Enable IPv6 networking + docker_ip_forward: + description: Enable net.ipv4.ip_forward + docker_ip_masq: + description: Enable IP masquerading + docker_labels: + description: Set key=value labels to the daemon + docker_live_restore: + description: Enables keeping containers alive during daemon downtime + docker_log_driver: + description: Default driver for container logs + docker_log_level: + description: Set the logging level + docker_log_opts: + description: Default log driver options for containers + docker_max_concurrent_downloads: + description: Set the max concurrent downloads for each pull + docker_max_concurrent_uploads: + description: Set the max concurrent uploads for each push + docker_mtu: + description: Set the containers network MTU + docker_oom_score_adjust: + description: Set the oom_score_adj for the daemon + docker_pidfile: + description: Path to use for daemon PID file + docker_raw_logs: + description: Full timestamps without ANSI coloring + docker_registry_mirrors: + description: Preferred Docker registry mirror + docker_runtimes: + description: Register an additional OCI compatible runtime + docker_selinux_enabled: + description: Enable selinux support + docker_swarm_default_advertise_addr: + description: Set default address or interface for swarm advertised address + docker_tls: + description: Use TLS; implied by –tlsverify + docker_tlscacert: + description: Trust certs signed only by this CA + docker_tlscert: + description: Path to TLS certificate file + docker_tlskey: + description: Path to TLS key file + docker_tlsverify: + description: Use TLS and verify the remote + docker_userland_proxy: + description: Use userland proxy for loopback traffic + docker_userns_remap: + description: User/Group setting for user namespaces + docker_users: + description: A list of system users to be added to the docker group (so they can use Docker on the server) + docker_http_proxy: + description: Set the Docker service to use HTTP_PROXY + docker_https_proxy: + description: Set the Docker service to use HTTPS_PROXY + docker_no_proxy_params: + description: Do not proxy for Docker service params diff --git a/roles/docker/tasks/ce/apt.yml b/roles/docker/tasks/ce/apt.yml index 34eb7ce..09aa5c0 100644 --- a/roles/docker/tasks/ce/apt.yml +++ b/roles/docker/tasks/ce/apt.yml @@ -25,8 +25,8 @@ - name: Docker | CE | APT | Ensure curl is present (systems without SNI). ansible.builtin.package: name: curl - - name: Docker | CE | APT | Download GPG key (systems without SNI). # noqa command-instead-of-module - ansible.builtin.shell: curl -sSL {{ docker_ce_gpg_key }} | sudo apt-key add - + - name: Docker | CE | APT | Download GPG key (systems without SNI). # noqa command-instead-of-module no-changed-when + ansible.builtin.command: curl -sSL {{ docker_ce_gpg_key }} | sudo apt-key add - - name: Docker | CE | APT | Configure Docker repository ansible.builtin.apt_repository: repo: "{{ docker_apt_repo_url }}" @@ -44,7 +44,12 @@ - name: Docker | CE | APT | Install docker-ce ansible.builtin.apt: - name: docker-ce + name: + - docker-ce + - docker-ce-cli + - containerd.io + - docker-buildx-plugin + - docker-compose-plugin state: present notify: Docker | Restart Docker register: task_result