os_coe_cluster_template – Добавление/удаление шаблона кластера COE из OpenStack Cloud
Новая в версии 2.7.
Описание
- Добавление или удаление шаблона кластера COE из сервиса OpenStack Container Infra.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени должна ждать сокет-слой перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он должен содержать auth_url, username, password, project_name и любую информацию о домене, если облако ее поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если предоставлен именованное облако или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type - | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости. | |
| cacert - | Путь к пакету сертификатов CA, который может использоваться для проверки запросов SSL API. | |
| cert - | Путь к клиенту сертификату для использования в рамках транзакции SSL. | |
| cloud - | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| coe - |
| Двигатель оркестрации контейнеров для данной шаблона кластера. |
| dns_nameserver - | По умолчанию: "8.8.8.8" | Адрес DNS сервера имен |
| docker_storage_driver - |
| Драйвер хранения Docker. |
| docker_volume_size - | Размер тома Docker в ГБ. | |
| external_network_id - | Внешняя сеть для подключения к кластеру. | |
| fixed_network - | Имя фиксированной сети для подключения к кластеру. | |
| fixed_subnet - | Имя фиксированной подсети для подключения к кластеру. | |
| flavor_id - | Тип виртуальной машины узел для данного шаблона кластера. | |
| floating_ip_enabled boolean |
| Указывает, должны ли созданные кластеры иметь плавающий IP-адрес или нет. |
| http_proxy - | Адрес прокси-сервера, который будет получать все HTTP-запросы и пересылать их. Формат — URL, включающий номер порта. | |
| https_proxy - | Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их. Формат — URL, включающий номер порта. | |
| image_id - | Идентификатор образа, на основе которого будет создан кластер. | |
| interface - добавлен в 2.3 |
| Тип URL-адреса конечной точки для получения из каталога служб. алиасы: endpoint_type |
| key - | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| keypair_id - | Имя или идентификатор пары ключей для использования. | |
| labels - | Один или несколько пар ключ/значение. | |
| master_flavor_id - | Тип виртуальной машины узла-мастера для данного шаблона кластера. | |
| master_lb_enabled boolean |
| Указывает, должны ли созданные кластеры иметь балансировщик нагрузки для узлов-мастеров или нет. |
| name - / обязательно | Имя, которое должно быть присвоено шаблону кластера. | |
| network_driver - |
| Имя драйвера, используемого для создания сетей контейнеров. |
| no_proxy - | Список IP-адресов, разделенных запятыми, для которых прокси-серверы не должны использоваться в кластере. | |
| public boolean |
| Указывает, является ли шаблон кластера общедоступным или нет. |
| region_name - | Имя региона. | |
| registry_enabled boolean |
| Указывает, включен ли реестр Docker. |
| server_type - |
| Тип сервера для данного шаблона кластера. |
| state - |
| Указывает желаемое состояние ресурса. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| tls_disabled boolean |
| Указывает, должен ли TLS быть отключен. |
| verify boolean |
| Проверять ли запросы SSL API. До версии 2.3 по умолчанию было True. алиасы: validate_certs |
| volume_driver - |
| Имя драйвера, используемого для создания томов контейнеров. |
| wait boolean |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем, наконец, из явных параметров в плейбуках. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create a new Kubernetes cluster template
- os_coe_cluster_template:
name: k8s
coe: kubernetes
keypair_id: mykey
image_id: 2a8c9888-9054-4b06-a1ca-2bb61f9adb72
public: no
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| cluster_template сложный | При успешном выполнении, когда состояние равно 'present' | Словарь, описывающий шаблон. | |
| coe строка | Двигатель оркестрации контейнеров для этого шаблона кластера Пример: kubernetes | ||
| dns_nameserver строка | Адрес DNS-сервера имен Пример: 8.8.8.8 | ||
| docker_storage_driver строка | Драйвер хранения Docker Пример: devicemapper | ||
| docker_volume_size целое число | Размер тома Docker в ГБ Пример: 5 | ||
| external_network_id строка | Внешняя сеть для подключения к кластеру Пример: public | ||
| fixed_network строка | Имя фиксированной сети для подключения к кластеру Пример: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d | ||
| fixed_subnet строка | Имя фиксированной подсети для подключения к кластеру Пример: 05567ec6-85f5-44cb-bd63-242a8e7f0d9d | ||
| flavor_id строка | Тип виртуальной машины для узла-миниона этого шаблона кластера Пример: c1.c1r1 | ||
| floating_ip_enabled булево | Указывает, нужно ли создавать кластеры с плавающим IP-адресом | ||
| http_proxy строка | Адрес прокси-сервера, который будет получать все HTTP-запросы и пересылать их. Формат — URL, включающий номер порта Пример: http://10.0.0.11:9090 | ||
| https_proxy строка | Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их. Формат — URL, включающий номер порта Пример: https://10.0.0.10:8443 | ||
| image_id строка | ID образа, на основе которого будет создаваться кластер Пример: 05567ec6-85f5-44cb-bd63-242a8e7f0e9d | ||
| keypair_id строка | Имя или ID пары ключей для использования. Пример: mykey | ||
| labels словарь | Один или несколько пар ключ/значение Пример: {'key1': 'value1', 'key2': 'value2'} | ||
| master_flavor_id строка | Тип виртуальной машины для узла-мастера этого шаблона кластера Пример: c1.c1r1 | ||
| master_lb_enabled булево | Указывает, нужно ли создавать кластеры с балансировщиком нагрузки для узлов-мастеров Пример: True | ||
| name строка | Имя, которое должно быть дано шаблону кластера Пример: k8scluster | ||
| network_driver строка | Имя драйвера, используемого для создания сетей контейнеров Пример: calico | ||
| no_proxy строка | Список IP-адресов, для которых не нужно использовать прокси в кластере, разделенные запятыми Пример: 10.0.0.4,10.0.0.5 | ||
| public булево | Указывает, является ли шаблон кластера общедоступным | ||
| registry_enabled булево | Указывает, включен ли реестр Docker | ||
| server_type строка | Тип сервера для данного шаблона кластера Пример: vm | ||
| tls_disabled булево | Указывает, отключен ли TLS | ||
| volume_driver строка | Имя драйвера, используемого для создания томов контейнеров Пример: cinder | ||
| id строка | При успешном выполнении, когда состояние равно 'present' | UUID кластера. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Feilong Wang (@flwang)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/os_coe_cluster_template_module.html
