Spec-Zone.ru › Ansible 2.11

community.docker.docker_network – Управление сетями Docker

Примечание

Этот плагин входит в состав коллекции community.docker (версия 1.2.2).

Для его установки используйте: ansible-galaxy collection install community.docker.

Для использования в книге задач укажите: community.docker.docker_network.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание/удаление сетей Docker и подключение контейнеров к ним.
  • В основном выполняет те же функции, что и подкоманда CLI «docker network».

Требования

Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.

  • Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и удалении одного из модулей другой может перестать работать, и потребуется его повторная установка.
  • 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
логическое значение
    Варианты:
  • нет
  • да
Если включено и сеть находится в глобальном пространстве, контейнеры-не-службы на узлах рабочих процессов смогут подключиться к сети.
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.docker.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
логическое значение
    Варианты:
  • нет
  • да
Включить IPv6-сетевое подключение.
force
логическое значение
    Варианты:
  • нет ←
  • да
В состоянии absent принудительно отключает все контейнеры от сети перед удалением сети. В состоянии present отключает все контейнеры, удаляет сеть и создаёт её заново.
Этот параметр необходим, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть для использования новых параметров.
internal
логическое значение
    Варианты:
  • нет
  • да
Ограничить внешний доступ к сети.
ipam_config
список / элементы=словарь
Список блоков конфигурации IPAM. Обратитесь к документации Docker https://docs.docker.com/compose/compose-file/compose-file-v2/#ipam для получения допустимых параметров и значений. Обратите внимание, что iprange здесь написан иначе (мы используем обозначения из Docker SDK для Python).
aux_addresses
словарь
Дополнительные IP-адреса, используемые драйвером сети, в виде сопоставления имя хоста — IP-адрес.
gateway
строка
IP-адрес шлюза.
iprange
строка
Диапазон IP-адресов в CIDR-нотации.
subnet
строка
Подмножество IP-адресов в CIDR-нотации.
ipam_driver
строка
Укажите драйвер IPAM.
ipam_driver_options
словарь
Словарь параметров драйвера IPAM.
labels
словарь
Словарь меток.
name
строка / обязательно
Имя сети для работы.

псевдонимы: network_name
scope
строка
    Варианты:
  • локальный
  • глобальный
  • swarm
Укажите область действия сети.
ssl_version
строка
Укажите версию SSL. Значение по умолчанию определяется модулем ssl.py.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_SSL_VERSION.
state
строка
    Варианты:
  • отсутствует
  • наличие ←
absent удаляет сеть. Если сеть имеет подключенные контейнеры, её нельзя удалить. Используйте параметр force, чтобы отключить все контейнеры и удалить сеть.
present создаёт сеть, если она ещё не существует с указанными параметрами, и подключает список контейнеров, указанных через параметр connected. Контейнеры, не входящие в список, будут отключены. Пустой список не будет подключать к сети никаких контейнеров. Используйте параметр appends, чтобы оставить существующие контейнеры подключенными. Используйте параметр force, чтобы принудительно пересоздать сеть.
timeout
целое число
По умолчанию:
60
Максимальное время ожидания ответа от API в секундах.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не задана, используется значение по умолчанию.
tls
логическое значение
    Варианты:
  • нет ←
  • да
Обеспечьте безопасность соединения с API, используя TLS без проверки подлинности сервера Docker Host. Обратите внимание, что если validate_certs также установлено в yes, оно будет иметь приоритет.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS. Если переменная окружения не задана, используется значение по умолчанию.
tls_hostname
строка
По умолчанию:
"localhost"
При проверке подлинности сервера Docker Host укажите ожидаемое имя сервера.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS_HOSTNAME. Если переменная окружения не задана, используется значение по умолчанию.
validate_certs
логическое значение
    Варианты:
  • нет ←
  • да
Обеспечьте безопасность соединения с API, используя TLS и проверяя подлинность сервера Docker host.
Если значение не указано в задаче, используется значение переменной окружения DOCKER_TLS_VERIFY. Если переменная окружения не задана, используется значение по умолчанию.

псевдонимы: tls_verify

Примечания

Примечание

  • При изменении сетевых параметров модуль отключает все контейнеры от сети, удаляет сеть и повторно создаёт её. Он не пытается повторно подключить контейнеры, кроме тех, которые перечислены в (connected), и даже для них не учитывает конкретные параметры подключения, такие как фиксированные IP-адреса или MAC-адреса. Если вам требуется больший контроль над подключением контейнеров к сети, используйте модуль community.docker.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 for Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
  • Обратите внимание, что Docker SDK for Python позволяет указать путь к конфигурации Docker только для очень ограниченного числа функций. В целом, он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.
  • Этот модуль использует Docker SDK for Python для связи с демоном Docker.

Примеры

- name: Create a network
  community.docker.docker_network:
    name: network_one

- name: Remove all but selected list of containers
  community.docker.docker_network:
    name: network_one
    connected:
      - container_a
      - container_b
      - container_c

- name: Remove a single container
  community.docker.docker_network:
    name: network_one
    connected: "{{ fulllist|difference(['container_a']) }}"

- name: Add a container to a network, leaving existing containers connected
  community.docker.docker_network:
    name: network_one
    connected:
      - container_a
    appends: yes

- name: Create a network with driver options
  community.docker.docker_network:
    name: network_two
    driver_options:
      com.docker.network.bridge.name: net2

- name: Create a network with custom IPAM config
  community.docker.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.docker.docker_network:
    name: network_four
    labels:
      key1: value1
      key2: value2

- name: Create a network with IPv6 IPAM config
  community.docker.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.docker.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.docker.docker_network:
    name: network_one
    state: absent
    force: yes

Значения возврата

Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
network
словарь
успех
Результаты проверки сети для затронутой сети.



Авторы

  • Ben Keith (@keitwb)
  • Chris Houseknecht (@chouseknecht)
  • Dave Bendit (@DBendit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_network_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API