community.general.docker_network – Управление сетями Docker
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.docker_network.
Обзор
- Создание/удаление сетей Docker и подключение контейнеров к ним.
- Выполняет в основном те же функции, что и подкоманда «docker network» CLI.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Для Python 2.6, необходимо использовать
docker-py. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны быть установлены одновременно. Также обратите внимание, что при установке и одновременном удалении обоих модулей другой может перестать работать, и потребуется его повторная установка. - Docker SDK для Python >= 1.10.0 (используйте docker-py для Python 2.6)
- Сервер Docker >= 1.10.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_version строка | Значение по умолчанию: "auto" | Версия API Docker, работающего на Docker Host. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, используется значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, используется значение по умолчанию.псевдонимы: docker_api_version | |
| appends логическое значение |
| По умолчанию подключенный список является каноническим, то есть контейнеры, отсутствующие в списке, удаляются из сети. Используйте appends, чтобы оставить подключенными существующие контейнеры. псевдонимы: incremental | |
| attachable логическое значение |
| Если включено и сеть находится в глобальном пространстве, не-сервисные контейнеры на узлах рабочих станций смогут подключаться к сети. | |
| ca_cert путь | Используйте сертификат CA при проверке сервера, предоставив путь к файлу сертификата CA. Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH установлена, используется файл ca.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.псевдонимы: tls_ca_cert, cacert_path | ||
| client_cert путь | Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH установлена, используется файл cert.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.псевдонимы: tls_client_cert, cert_path | ||
| client_key путь | Путь к файлу ключа TLS клиента. Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH установлена, используется файл key.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.псевдонимы: tls_client_key, key_path | ||
| connected список / элементы=строка | Список имён или идентификаторов контейнеров для подключения к сети. Обратите внимание, что модуль только гарантирует подключение этих контейнеров к сети, но не заботится о параметрах подключения. Если вы полагаетесь на конкретные IP-адреса и т. д., используйте модуль community.general.docker_container для обеспечения правильного подключения ваших контейнеров к этой сети. псевдонимы: containers | ||
| debug логическое значение |
| Режим отладки | |
| docker_host строка | Значение по умолчанию: "unix://var/run/docker.sock" | URL или путь к Unix-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL соединения на https.Если значение не указано в задаче, используется значение переменной среды DOCKER_HOST. Если переменная среды не задана, используется значение по умолчанию.псевдонимы: docker_url | |
| driver строка | Значение по умолчанию: "bridge" | Укажите тип сети. Docker предоставляет драйверы bridge и overlay, но также можно использовать драйверы сторонних производителей. | |
| driver_options словарь | Словарь настроек сети. Обратитесь к документации docker для допустимых опций и значений. | ||
| enable_ipv6 логическое значение |
| Включить IPv6-сетевое подключение. | |
| force логическое значение |
| Состояние absent принудительно отключает все контейнеры от сети перед удалением сети. Состояние present отключает все контейнеры, удаляет сеть и пересоздаёт её.Эта опция необходима, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть, чтобы она использовала новые параметры. | |
| internal логическое значение |
| Ограничить внешний доступ к сети. | |
| ipam_config список / элементы=словарь | Список блоков конфигурации IPAM. Обратитесь к документации Docker за допустимыми опциями и значениями. Обратите внимание, что iprange здесь написано иначе (мы используем обозначение из Docker SDK для Python). | ||
| aux_addresses словарь | Вспомогательные IP-адреса, используемые драйвером сети, как отображение имени хоста на IP-адрес. | ||
| gateway строка | IP-адрес шлюза. | ||
| iprange строка | Диапазон IP-адресов в CIDR-нотации. | ||
| subnet строка | Подмножество IP-адресов в CIDR-нотации. | ||
| ipam_driver строка | Укажите драйвер IPAM. | ||
| ipam_driver_options словарь | Словарь опций драйвера IPAM. | ||
| ipam_options словарь | Словарь опций IPAM. Устарело в версии 2.8, будет удалено в community.general 2.0.0. Используйте параметр ipam_config вместо него. В Docker 1.10.0 были введены опции IPAM (см. здесь). Этот параметр модуля описывает конфигурацию IPAM, а не новые опции IPAM. Для опций IPAM см. параметр ipam_driver_options. | ||
| aux_addresses словарь | Вспомогательные IP-адреса, используемые драйвером сети, как отображение имени хоста на IP-адрес. | ||
| gateway строка | IP-адрес шлюза. | ||
| iprange строка | Диапазон IP-адресов в CIDR-нотации. | ||
| subnet строка | Подмножество IP-адресов в CIDR-нотации. | ||
| labels словарь | Словарь меток. | ||
| name строка / обязательно | Имя сети, с которой нужно работать. псевдонимы: network_name | ||
| scope строка |
| Укажите область сети. | |
| ssl_version строка | Укажите версию SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной среды DOCKER_SSL_VERSION. | ||
| state строка |
| absent удаляет сеть. Если сеть имеет подключенные контейнеры, её нельзя удалить. Используйте опцию force, чтобы отключить все контейнеры и удалить сеть.present создаёт сеть, если она ещё не существует с указанными параметрами, и подключает список контейнеров, предоставленных через параметр connected. Контейнеры, не входящие в список, будут отключены. Пустой список не будет подключать контейнеры к сети. Используйте опцию appends, чтобы оставить существующие контейнеры подключёнными. Используйте опцию force для принудительного пересоздания сети. | |
| timeout целое число | Значение по умолчанию: 60 | Максимальное время в секундах ожидания ответа от API. Если значение не указано в задаче, используется значение переменной среды DOCKER_TIMEOUT. Если переменная среды не задана, используется значение по умолчанию. | |
| tls логическое значение |
| Защитить подключение к API с помощью TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также установлено в yes, оно будет иметь приоритет.Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS. Если переменная среды не задана, используется значение по умолчанию. | |
| tls_hostname строка | Значение по умолчанию: "localhost" | При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS_HOSTNAME. Если переменная среды не задана, используется значение по умолчанию. | |
| validate_certs boolean |
| Обеспечение безопасности соединения с API с использованием TLS и проверки подлинности хоста Docker. Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_TLS_VERIFY. Если переменная среды не задана, будет использовано значение по умолчанию.псевдонимы: tls_verify | |
Примечания
Примечание
- При изменении сетевых параметров модуль отключает все контейнеры от сети, удаляет сеть и снова создает ее. Он не пытается повторно подключить контейнеры, за исключением тех, которые перечислены в (connected, и даже для них не учитывает такие параметры подключения, как фиксированные IP-адреса или MAC-адреса. Если вам нужен больший контроль над подключением контейнеров к сети, используйте модуль community.general.docker_container для перебора контейнеров, чтобы убедиться, что они подключены должным образом.
- Модуль не поддерживает Docker Swarm, т.е. он не будет пытаться отключить или подключить службы. Если службы подключены к сети, удаление сети завершится ошибкой. При изменении сетевых параметров сеть должна быть удалена и пересоздана, поэтому это также приведет к ошибке.
- Подключение к демону Docker можно выполнить, передав параметры с каждой задачей или определив переменные среды. Вы можете определить
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_SSL_VERSION,DOCKER_TLS,DOCKER_TLS_VERIFYиDOCKER_TIMEOUT. Если вы используете docker machine, запустите скрипт, поставляемый с продуктом, для настройки среды. Он установит эти переменные за вас. Дополнительные сведения см. в https://docs.docker.com/machine/reference/env/. - При подключении к демону Docker с TLS может потребоваться установка дополнительных пакетов Python. Для Docker SDK для Python версии 2.4 или более поздней это можно сделать, установив
docker[tls]с помощью ansible.builtin.pip. - Обратите внимание, что Docker SDK для Python позволяет указать только путь к конфигурации Docker для очень небольшого количества функций. В общем случае он будет использовать
$HOME/.docker/config.json, если переменная средыDOCKER_CONFIGне задана, и использовать$DOCKER_CONFIG/config.jsonв противном случае.
Примеры
- name: Create a network
community.general.docker_network:
name: network_one
- name: Remove all but selected list of containers
community.general.docker_network:
name: network_one
connected:
- container_a
- container_b
- container_c
- name: Remove a single container
community.general.docker_network:
name: network_one
connected: "{{ fulllist|difference(['container_a']) }}"
- name: Add a container to a network, leaving existing containers connected
community.general.docker_network:
name: network_one
connected:
- container_a
appends: yes
- name: Create a network with driver options
community.general.docker_network:
name: network_two
driver_options:
com.docker.network.bridge.name: net2
- name: Create a network with custom IPAM config
community.general.docker_network:
name: network_three
ipam_config:
- subnet: 172.3.27.0/24
gateway: 172.3.27.2
iprange: 172.3.27.0/26
aux_addresses:
host1: 172.3.27.3
host2: 172.3.27.4
- name: Create a network with labels
community.general.docker_network:
name: network_four
labels:
key1: value1
key2: value2
- name: Create a network with IPv6 IPAM config
community.general.docker_network:
name: network_ipv6_one
enable_ipv6: yes
ipam_config:
- subnet: fdd1:ac8c:0557:7ce1::/64
- name: Create a network with IPv6 and custom IPv4 IPAM config
community.general.docker_network:
name: network_ipv6_two
enable_ipv6: yes
ipam_config:
- subnet: 172.4.27.0/24
- subnet: fdd1:ac8c:0557:7ce2::/64
- name: Delete a network, disconnecting all containers
community.general.docker_network:
name: network_one
state: absent
force: yes
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращенное | Описание |
|---|---|---|
| network словарь | успех | Результаты проверки сети для затронутой сети. Обратите внимание, что факты являются частью зарегистрированных переменных Ansible начиная с версии 2.8. По соображениям совместимости факты также доступны непосредственно как docker_network. Обратите внимание, что возвращаемый факт будет удален в версии community.general 2.0.0. |
Авторы
- Ben Keith (@keitwb)
- Chris Houseknecht (@chouseknecht)
- Dave Bendit (@DBendit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/docker_network_module.html