openstack.cloud.coe_cluster – Добавление/удаление кластера COE из OpenStack Cloud
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud
Для использования в плейбуке укажите: openstack.cloud.coe_cluster
Описание
- Добавление или удаление кластера 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, который можно использовать для проверки запросов SSL API. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud сырой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| cluster_template_id строка / обязательно | Идентификатор шаблона кластера. | |
| discovery_url строка | URL, используемый для обнаружения узлов кластера. | |
| docker_volume_size целое число | Размер тома Docker в ГБ. | |
| flavor_id строка | Тип виртуальной машины узла подчиненного узла для данного шаблона кластера. | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| keypair строка | Имя пары ключей для использования. | |
| labels сырой | Один или несколько пар ключ/значение. | |
| master_count целое число | По умолчанию: 1 | Количество узлов-мастеров для этого кластера. |
| master_flavor_id строка | Тип виртуальной машины узла-мастера для данного шаблона кластера. | |
| name строка / обязательно | Имя, которое должно быть дано шаблону кластера. | |
| node_count целое число | По умолчанию: 1 | Количество узлов для этого кластера. |
| region_name строка | Имя региона. | |
| state строка |
| Указывает желаемое состояние ресурса. |
| timeout целое число | По умолчанию: 60 | Таймаут для создания кластера в минутах. По умолчанию 60 минут, если не задано. |
| validate_certs логическое |
| Нужно ли проверять запросы SSL API. До Ansible 2.3 это по умолчанию было yes.псевдонимы: verify |
| 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
- openstack.cloud.coe_cluster:
name: k8s
cluster_template_id: k8s-ha
keypair: mykey
master_count: 3
node_count: 5
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| cluster сложный тип данных | При успехе, когда state равно 'present' | Словарь, описывающий кластер. | |
| api_address строка | успех | Адрес API узла-мастера кластера Пример: https://172.24.4.30:6443 | |
| cluster_template_id строка | успех | UUID шаблона кластера Пример: 7b1418c8-cea8-48fc-995d-52b66af9a9aa | |
| coe_version строка | успех | Версия программного обеспечения COE, работающего в данном кластере Пример: v1.11.1 | |
| container_version строка | успех | Версия контейнерного ПО. Например, версия Docker. Пример: 1.12.6 | |
| create_timeout целое число | успех | Таймаут для создания кластера в минутах. По умолчанию 60, если не задано. Пример: 60 | |
| created_at строка | успех | Время создания кластера в UTC Пример: 2018-08-16T10:29:45+00:00 | |
| discovery_url строка | успех | URL, используемый для обнаружения узлов кластера Пример: https://discovery.etcd.io/a42ee38e7113f31f4d6324f24367aae5 | |
| faults словарь | успех | Информация о сбоях, собранная из ресурсов Heat для данного кластера Пример: {'0': 'ResourceInError: resources[0].resources...'} | |
| flavor_id строка | успех | Тип виртуальной машины (flavor) узел-минион для данного кластера Пример: c1.c1r1 | |
| id строка | успех | Уникальный UUID для данного кластера Пример: 86246a4d-a16c-4a58-9e96ad7719fe0f9d | |
| keypair строка | успех | Имя пары ключей для использования. Пример: mykey | |
| labels словарь | успех | Одна или несколько пар ключ/значение Пример: {'key1': 'value1', 'key2': 'value2'} | |
| master_addresses список / элементы=строка | успех | IP-адреса узлов-мастеров кластера Пример: ['172.24.4.5'] | |
| master_count целое число | успех | Количество узлов-мастеров для данного кластера. Пример: 1 | |
| master_flavor_id строка | успех | Тип виртуальной машины (flavor) узла-мастера для данного кластера Пример: c1.c1r1 | |
| name строка | успех | Имя, которое нужно присвоить кластеру Пример: k8scluster | |
| node_addresses список / элементы=строка | успех | IP-адреса узлов-рабочих мест кластера Пример: ['172.24.4.8'] | |
| node_count целое число | успех | Количество узлов-мастеров для данного кластера. Пример: 1 | |
| stack_id строка | успех | Идентификатор стека Heat Пример: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d | |
| status строка | успех | Статус кластера из стека heat Пример: CREATE_COMLETE | |
| status_reason строка | успех | Причина статуса кластера из стека heat Пример: Операция CREATE стека завершена успешно | |
| updated_at строка | успех | Время обновления кластера в UTC Пример: 2018-08-16T10:39:25+00:00 | |
| id строка | При успехе, когда state равно 'present' | UUID кластера. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
Авторы
- Группа OpenStack Ansible SIG
© 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/openstack/cloud/coe_cluster_module.html
