docker_network – Управление сетями Docker
Новая в версии 2.2.
Описание
- Создание/удаление сетей Docker и подключение контейнеров к ним.
- Выполняет в основном ту же функцию, что и подкоманда CLI «docker network».
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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" | Версия Docker API, работающая на Docker Host. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и docker демоном. Если значение не указано в задаче, используется значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, используется значение по умолчанию.псевдонимы: docker_api_version | |
| appends логическое |
| По умолчанию подключённый список является каноническим, что означает, что контейнеры, отсутствующие в списке, удаляются из сети. Используйте appends, чтобы оставить существующие контейнеры подключёнными. псевдонимы: incremental | |
| attachable логическое добавлено в 2.8 |
| Если включено и сеть находится в глобальной области, контейнеры, не являющиеся службами, на узлах рабочих процессов смогут подключаться к сети. | |
| 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-адреса и т. д., используйте модуль docker_container, чтобы убедиться, что ваши контейнеры правильно подключены к этой сети. псевдонимы: containers | ||
| debug логическое |
| Режим отладки | |
| docker_host строка | Значение по умолчанию: "unix://var/run/docker.sock" | URL или путь к Unix-сокету, используемые для подключения к Docker API. Для подключения к удалённому узлу укажите строку 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 логическое добавлено в 2.8 |
| Включить IPv6-сети. | |
| force логическое |
| В состоянии absent принудительно отключает все контейнеры от сети перед удалением сети. В состоянии present отключит все контейнеры, удалит сеть и снова создаст её.Эта опция требуется, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть для использования новых параметров. | |
| internal логическое добавлено в 2.8 |
| Ограничить внешний доступ к сети. | |
| ipam_config список добавлено в 2.8 | Список блоков конфигурации IPAM. Обратитесь к документации Docker для получения допустимых вариантов и значений. Обратите внимание, что iprange написано по-другому (мы используем обозначения из Docker SDK для Python). | ||
| aux_addresses словарь | Дополнительные IP-адреса, используемые драйвером сети, как отображение имени хоста на IP. | ||
| gateway строка | IP-адрес шлюза. | ||
| iprange строка | Диапазон IP-адресов в CIDR-нотации. | ||
| subnet строка | Подмножество IP-адресов в CIDR-нотации. | ||
| ipam_driver строка | Укажите драйвер IPAM. | ||
| ipam_driver_options словарь добавлено в 2.8 | Словарь параметров драйвера IPAM. | ||
| ipam_options словарь | Словарь параметров IPAM. Устарело в 2.8, будет удалено в 2.12. Вместо этого используйте параметр 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 словарь добавлено в 2.8 | Словарь меток. | ||
| name строка / обязательно | Имя сети, с которой нужно работать. псевдонимы: network_name | ||
| scope строка добавлено в 2.8 |
| Укажите область действия сети. | |
| 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 булево |
| Защитите подключение к API с использованием TLS и проверкой подлинности сервера Docker. Если значение не указано в задании, будет использовано значение переменной окружения DOCKER_TLS_VERIFY вместо него. Если переменная окружения не задана, будет использовано значение по умолчанию.псевдонимы: tls_verify | |
Примечания
Примечание
- При изменении параметров сети модуль отключает все контейнеры от сети, удаляет сеть и пересоздает её. Он не пытается снова подключить контейнеры, кроме тех, которые указаны в (connected, и даже для них не учитывает конкретные параметры подключения, такие как фиксированные IP-адреса или MAC-адреса. Если вам нужен больший контроль над подключением контейнеров к сети, используйте цикл с модулем 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://docker-py.readthedocs.io/en/stable/machine/ для получения дополнительной информации. - При подключении к демону Docker с TLS, вам, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или новее это можно сделать, установив
docker[tls]с помощью pip. - Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае, он будет использовать
$HOME/.docker/config.json, если переменная окруженияDOCKER_CONFIGне указана, и использовать$DOCKER_CONFIG/config.jsonв противном случае.
Примеры
- name: Create a network
docker_network:
name: network_one
- name: Remove all but selected list of containers
docker_network:
name: network_one
connected:
- container_a
- container_b
- container_c
- name: Remove a single container
docker_network:
name: network_one
connected: "{{ fulllist|difference(['container_a']) }}"
- name: Add a container to a network, leaving existing containers connected
docker_network:
name: network_one
connected:
- container_a
appends: yes
- name: Create a network with driver options
docker_network:
name: network_two
driver_options:
com.docker.network.bridge.name: net2
- name: Create a network with custom IPAM config
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
docker_network:
name: network_four
labels:
key1: value1
key2: value2
- name: Create a network with IPv6 IPAM config
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
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
docker_network:
name: network_one
state: absent
force: yes
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| network словарь | успех | Результаты проверки сети для затронутой сети. Обратите внимание, что факты являются частью зарегистрированных переменных с Ansible 2.8. По соображениям совместимости факты также доступны непосредственно как docker_network. Обратите внимание, что возвращаемый факт будет удален в Ansible 2.12. |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/docker_network_module.html