os_coe_cluster_template – Добавление/удаление шаблона кластера COE из OpenStack Cloud
Новое в версии 2.7.
Описание
- Добавить или удалить шаблон кластера COE из сервиса OpenStack Container Infra.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать подсистема сокетов, прежде чем истечёт время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если их поддерживает облако. Для других плагинов этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету CA Cert, который может использоваться для проверки запросов 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 - | Тип виртуальной машины узел-минион для этого шаблона кластера | |
| floating_ip_enabled булево |
| Указывает, должны ли созданные кластеры иметь плавающий IP-адрес или нет |
| http_proxy - | Адрес прокси, который будет получать все HTTP-запросы и перенаправлять их. Формат — URL, включая номер порта. | |
| https_proxy - | Адрес прокси, который будет получать все HTTPS-запросы и перенаправлять их. Формат — URL, включая номер порта. | |
| image_id - | ID образа, на основе которого будет создан кластер | |
| interface строка добавлено в 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| keypair_id - | Имя или ID пары ключей для использования. | |
| labels - | Один или несколько пар ключ/значение | |
| master_flavor_id - | Тип виртуальной машины узла-мастера для этого шаблона кластера | |
| master_lb_enabled булево |
| Указывает, должны ли созданные кластеры иметь балансировщик нагрузки для узлов-мастеров или нет |
| name - / обязательно | Имя, которое должно быть дано шаблону кластера | |
| network_driver - |
| Имя драйвера, используемого для создания сетей контейнеров |
| no_proxy - | Список IP-адресов, для которых не нужно использовать прокси в кластере, разделённые запятыми | |
| public булево |
| Указывает, является ли шаблон кластера общедоступным или нет |
| region_name строка | Имя региона. | |
| registry_enabled булево |
| Указывает, включён ли реестр Docker |
| server_type - |
| Тип сервера для этого шаблона кластера |
| state - |
| Указывает желаемое состояние ресурса. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| tls_disabled булево |
| Указывает, должен ли быть отключён TLS |
| validate_certs булево |
| Необходимо ли проверять запросы API SSL. До 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
- 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-адрес или нет Пример: 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 строка | Имя или 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. [community]
Авторы
- 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.8/modules/os_coe_cluster_template_module.html
