openstack.cloud.os_coe_cluster_template – Добавление/удаление шаблона кластера COE из OpenStack Cloud
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.os_coe_cluster_template.
Обзор
- Добавление или удаление шаблона кластера COE из сервиса OpenStack Container Infra.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная прослойка при таймауте вызовов API. Если этот параметр опущен, в библиотеку requests ничего не передастся. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если предоставлен именованное облако или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Находится для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| 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 строка | Тип виртуальной машины узла minion для этого шаблона кластера | |
| floating_ip_enabled логическое значение |
| Указывает, должны ли созданные кластеры иметь плавающий IP-адрес или нет |
| http_proxy строка | Адрес прокси-сервера, который получит все HTTP-запросы и перенаправит их. Формат — URL с номером порта. | |
| https_proxy строка | Адрес прокси-сервера, который получит все HTTPS-запросы и перенаправит их. Формат — URL с номером порта. | |
| image_id строка / обязательно | Идентификатор образа, на основе которого будет создаваться кластер | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| keypair_id строка | Имя или ID пары ключей для использования. | |
| labels сырой | Один или несколько пар ключ/значение | |
| master_flavor_id строка | Тип виртуальной машины узла master для этого шаблона кластера | |
| master_lb_enabled логическое значение |
| Указывает, нужно ли создавать балансировщик нагрузки для узлов master в созданных кластерах или нет |
| name строка / обязательно | Имя, которое должно быть задано для шаблона кластера | |
| network_driver строка |
| Имя драйвера, используемого для создания сетей контейнеров |
| no_proxy строка | Список IP-адресов, для которых не следует использовать прокси в кластере, разделенных запятыми. | |
| public логическое значение |
| Указывает, является ли шаблон кластера публичным или нет |
| region_name строка | Имя региона. | |
| registry_enabled логическое значение |
| Указывает, включен ли реестр Docker |
| server_type строка |
| Тип сервера для этого шаблона кластера |
| state строка |
| Указывает желаемое состояние ресурса. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| tls_disabled логическое значение |
| Указывает, должен ли TLS быть отключен |
| validate_certs логическое значение |
| Нужно ли проверять запросы SSL API. До Ansible 2.3 это было по умолчанию yes.псевдонимы: verify |
| volume_driver строка |
| Имя драйвера, используемого для создания томов контейнеров |
| wait логическое значение |
| Должен ли Ansible ждать, пока запрашиваемый ресурс завершит работу. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в сценариях. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create a new Kubernetes cluster template
- openstack.cloud.coe_cluster_template:
name: k8s
coe: kubernetes
keypair_id: mykey
image_id: 2a8c9888-9054-4b06-a1ca-2bb61f9adb72
public: no
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| cluster_template сложный | При успехе, когда state равно '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-адрес или нет Пример: True | |
| http_proxy строка | успех | Адрес прокси, который будет принимать все HTTP-запросы и пересылать их. Формат — URL, включающий номер порта. Пример: http://10.0.0.11:9090 | |
| https_proxy строка | успех | Адрес прокси, который будет принимать все HTTPS-запросы и пересылать их. Формат — URL, включающий номер порта. Пример: https://10.0.0.10:8443 | |
| image_id строка | успех | Идентификатор образа, на основе которого будет создаваться кластер Пример: 05567ec6-85f5-44cb-bd63-242a8e7f0e9d | |
| keypair_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 строка | При успехе, когда state равно 'present' | UUID кластера. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_coe_cluster_template_module.html
