Spec-Zone.ru › Ansible 2.10

openstack.cloud.os_coe_cluster – Добавление/удаление кластера COE из OpenStack Cloud

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в playbook, укажите: openstack.cloud.os_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 Cert, который может использоваться для проверки запросов 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
строка
Flavor узла-клиента для этого шаблона кластера
interface
строка
    Варианты:
  • admin
  • internal
  • public ←
Тип URL конечной точки для извлечения из каталога сервисов.

Псевдонимы: endpoint_type
keypair
строка
Имя пары ключей для использования.
labels
сырой
Одна или несколько пар ключ/значение
master_count
целое число
По умолчанию:
1
Количество узлов-мастеров для данного кластера
master_flavor_id
строка
Flavor узла-мастера для данного шаблона кластера
name
строка / обязательно
Имя, которое должно быть присвоено шаблону кластера
node_count
целое число
По умолчанию:
1
Количество узлов для данного кластера
region_name
строка
Имя региона.
state
строка
    Варианты:
  • present ←
  • absent
Укажите желаемое состояние ресурса.
timeout
целое число
По умолчанию:
60
Время ожидания создания кластера в минутах. По умолчанию 60 минут, если не задано.
validate_certs
булево
    Варианты:
  • no ←
  • yes
Проверка запросов SSL API.
До Ansible 2.3 по умолчанию было yes.

Псевдонимы: verify
wait
булево
    Варианты:
  • no
  • yes ←
Должен ли Ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

  • Можно использовать стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
  • Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Дополнительную информацию можно найти по адресу 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–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_module.html

Spec-Zone.ru

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