Spec-Zone.ru › Ansible 2.7

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

Новое в версии 2.2.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Описание

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

Требования

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

  • python >= 2.6
  • docker-py >= 1.7.0
  • Обратите внимание, что модуль Python docker-py был заменён на docker (см. здесь для подробностей). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны быть установлены одновременно. Также обратите внимание, что при установке и удалении одного из них, другой может перестать работать, и потребуется его повторная установка.
  • Сервер Docker >= 1.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_version
-
Значение по умолчанию:
"auto"
Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py.
Если значение не указано в задаче, используется значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, используется значение по умолчанию.

псевдонимы: docker_api_version
appends
boolean
    Варианты:
  • нет ←
  • да
По умолчанию список подключённых элементов является каноническим, то есть контейнеры, отсутствующие в списке, удаляются из сети. Используйте appends, чтобы сохранить подключение существующих контейнеров.

псевдонимы: incremental
cacert_path
-
Используйте сертификат CA при проверке подлинности сервера, указав путь к файлу сертификата CA.
Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH задана, используется файл ca.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_ca_cert
cert_path
-
Путь к файлу TLS-сертификата клиента.
Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH задана, используется файл cert.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_client_cert
connected
-
Список имён или идентификаторов контейнеров для подключения к сети.

псевдонимы: containers
debug
boolean
    Варианты:
  • нет ←
  • да
Режим отладки
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 для получения допустимых параметров и значений.
force
boolean
    Варианты:
  • нет ←
  • да
В состоянии отсутствует принудительно отключает все контейнеры от сети перед удалением сети. В состоянии есть отключает все контейнеры, удаляет сеть и создаёт сеть заново. Этот параметр необходим, если вы изменили параметры IPAM или драйвера и хотите обновить существующую сеть для использования новых параметров.
ipam_driver
-
Укажите драйвер IPAM.
ipam_options
-
Словарь параметров IPAM.
key_path
-
Путь к файлу TLS-ключа клиента.
Если значение не указано в задаче и переменная среды DOCKER_CERT_PATH задана, используется файл key.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_client_key
name
- / обязательно
Имя сети для обработки.

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

Примечания

Примечание

  • Подключитесь к демону 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 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
словарь
успех
Результаты проверки сети для затронутой сети.



Статус

  • Для этого модуля не гарантируется обратная совместимость. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.7/modules/docker_network_module.html

Spec-Zone.ru

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