docker_network - Управление сетями Docker
Новая в версии 2.2.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создание/удаление сетей Docker и подключение контейнеров к ним.
- Выполняет в основном те же функции, что и подкоманда «docker network» командной строки.
Требования (к хосту, на котором выполняется модуль)
- 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 | нет | Использование сертификата CA при проверке подлинности сервера путем указания пути к файлу сертификата CA. псевдонимы: tls_ca_cert | ||
| cert_path | нет | Путь к файлу TLS-сертификата клиента. псевдонимы: tls_client_cert | ||
| connected | нет | Список имён или идентификаторов контейнеров для подключения к сети. псевдонимы: 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 | нет | Словарь параметров сети. Обратитесь к документации Docker за допустимыми параметрами и значениями. | ||
| force | нет | При состоянии absent принудительно отключает все контейнеры от сети перед удалением сети. При состоянии present отключает все контейнеры, удаляет сеть и создаёт новую. Этот параметр необходим, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть для использования новых параметров. | ||
| ipam_driver | нет | Укажите драйвер IPAM. | ||
| ipam_options | нет | Словарь параметров IPAM. | ||
| key_path | нет | Путь к файлу TLS-ключа клиента. псевдонимы: tls_client_key | ||
| name | да | Имя сети, с которой необходимо работать. псевдонимы: network_name | ||
| ssl_version | нет | 1.0 | Укажите версию SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0. | |
| state | нет | present |
|
absent удаляет сеть. Если сеть имеет подключенные контейнеры, её нельзя удалить. Используйте параметр force для отключения всех контейнеров и удаления сети.
present создаёт сеть, если она ещё не существует с указанными параметрами, и подключает список контейнеров, указанный в параметре connected. Контейнеры, не входящие в список, будут отключены. Пустой список не подключит к сети ни один контейнер. Используйте параметр appends для сохранения подключения существующих контейнеров. Используйте параметр force для принудительного пересоздания сети. |
| timeout | нет | 60 | Максимальное время ожидания ответа от API в секундах. | |
| tls | нет | Защитите соединение с API с помощью TLS без проверки подлинности хоста Docker. | ||
| tls_hostname | нет | localhost | При проверке подлинности хоста Docker укажите ожидаемое имя сервера. | |
| tls_verify | нет | Защитите соединение с API с помощью TLS и проверьте подлинность хоста Docker. |
Примеры
- 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 | {} |
Примечания
Примечание
- Подключение к демону 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/.
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы в этом, пожалуйста, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/docker_network_module.html
