docker_network - Управление сетями Docker
Новое в версии 2.2.
Обзор
- Создание/удаление сетей Docker и подключение контейнеров к ним.
- В основном выполняет ту же функцию, что и подкоманда «docker network» CLI.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- docker-py >= 1.7.0
- Сервер docker >= 1.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_version | По умолчанию: значение по умолчанию, предоставляемое docker-py | Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. Псевдонимы: docker_api_version |
| appends | По умолчанию: нет | По умолчанию соединенный список является каноническим, т. е. контейнеры, не включенные в список, удаляются из сети. Используйте appends для сохранения подключения существующих контейнеров.Псевдонимы: incremental |
| cacert_path | По умолчанию: None | Используйте сертификат CA при проверке подлинности сервера, указав путь к файлу сертификата CA. Псевдонимы: tls_ca_cert |
| cert_path | По умолчанию: None | Путь к файлу TLS-сертификата клиента. Псевдонимы: tls_client_cert |
| connected | По умолчанию: None | Список имён контейнеров или идентификаторов контейнеров для подключения к сети. Псевдонимы: containers |
| docker_host | По умолчанию: unix://var/run/docker.sock | URL или путь к Unix-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-подключения. Например, 'tcp://192.0.2.23:2376'. Если для шифрования подключения используется TLS, модуль автоматически заменит 'tcp' в URL подключения на 'https'. Псевдонимы: docker_url |
| driver | По умолчанию: bridge | Укажите тип сети. Docker предоставляет драйверы bridge и overlay, но также можно использовать драйверы сторонних разработчиков. |
| driver_options | По умолчанию: None | Словарь параметров сети. Обратитесь к документации Docker для получения допустимых вариантов и значений. |
| force | По умолчанию: нет | В состоянии absent принудительно отключает все контейнеры от сети перед удалением сети. В состоянии present отключит все контейнеры, удалит сеть и пересоздаст её. Этот параметр необходим, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть для использования новых параметров. |
| ipam_driver | По умолчанию: None | Укажите драйвер IPAM. |
| ipam_options | По умолчанию: None | Словарь параметров IPAM. |
| key_path | По умолчанию: None | Путь к файлу ключа TLS-клиента. Псевдонимы: tls_client_key |
| name обязательно | Имя сети, над которой нужно выполнить операцию. Псевдонимы: network_name | |
| ssl_version | По умолчанию: 1.0 | Укажите допустимый номер версии SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0. |
| state |
|
absent удаляет сеть. Если сеть подключена к контейнерам, она не может быть удалена. Используйте параметр force для отключения всех контейнеров и удаления сети.
present создаёт сеть, если она не существует с указанными параметрами, и подключает список контейнеров, предоставленных через параметр connected. Контейнеры, не включённые в список, будут отключены. Пустой список не подключит к сети никаких контейнеров. Используйте параметр appends для сохранения подключения существующих контейнеров. Используйте параметр force для принудительного пересоздания сети. |
| timeout | По умолчанию: 60 | Максимальное время в секундах ожидания ответа от API. |
| tls | По умолчанию: нет | Защитите подключение к API с помощью TLS без проверки подлинности сервера Docker. |
| tls_hostname | По умолчанию: localhost | При проверке подлинности сервера Docker укажите ожидаемое имя сервера. |
| tls_verify | По умолчанию: нет | Защитите подключение к API с помощью TLS и проверьте подлинность сервера Docker. |
Примечания
Примечание
- Подключитесь к демону 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.org/en/stable/machine/
Примеры
- 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 options
docker_network:
name: network_two
driver_options:
com.docker.network.bridge.name: net2
ipam_options:
subnet: '172.3.26.0/16'
gateway: 172.3.26.1
iprange: '192.168.1.0/24'
- name: Delete a network, disconnecting all containers
docker_network:
name: network_one
state: absent
force: yes
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| facts dict | успех | Результаты проверки сети для затронутой сети. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- Ben Keith (@keitwb)
- Chris Houseknecht (@chouseknecht)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/docker_network_module.html
