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

Новая в версии 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Добавление или удаление кластера COE из сервиса OpenStack Container Infra.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должен ждать уровень сокетов, прежде чем произойдёт таймаут API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests.
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, который можно использовать для проверки 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 -		Flavour узла-миниона для этого ClusterTemplate.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. алиасы: endpoint_type
keypair -		Имя keypair для использования.
labels -		Одна или несколько пар ключ-значение.
master_count -	Значение по умолчанию: 1	Количество узлов-мастеров для данного кластера.
master_flavor_id -		Flavor узла-мастера для этого ClusterTemplate.
name - / обязательно		Имя, которое должно быть задано для шаблона кластера.
node_count -	Значение по умолчанию: 1	Количество узлов для данного кластера.
region_name строка		Имя региона.
state -	Варианты: present ← absent	Указывает желаемое состояние ресурса.
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
- os_coe_cluster:
    name: k8s
    cluster_template_id: k8s-ha
    keypair: mykey
    master_count: 3
    node_count: 5

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключевые значения		Возвращаемое значение	Описание
cluster сложный		При успехе, когда состояние равно '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 version. Пример: 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 строка		Тип узла-клиента (minion) для этого кластера Пример: c1.c1r1
	keypair строка		Имя используемой пары ключей Пример: mykey
	labels словарь		Одна или несколько пар ключ/значение Пример: {'key1': 'value1', 'key2': 'value2'}
	master_addresses список		IP-адреса узлов-мастеров кластера Пример: ['172.24.4.5']
	master_count целое число		Количество узлов-мастеров в этом кластере. Пример: 1
	master_flavor_id строка		Тип узла-мастера для этого кластера Пример: c1.c1r1
	name строка		Имя, которое должно быть присвоено кластеру Пример: k8scluster
	node_addresses список		IP-адреса узлов-клиентов (slave) кластера Пример: ['172.24.4.8']
	node_count целое число		Количество узлов-мастеров в этом кластере. Пример: 1
	stack_id строка		Идентификатор стека Heat Пример: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d
	status строка		Статус кластера из стека Heat Пример: CREATE_COMLETE
	status_reason строка		Описание статуса кластера из стека Heat Пример: Успешное завершение создания стека
	updated_at строка		Время обновления кластера в формате UTC Пример: 2018-08-16T10:39:25+00:00
	uuid строка		Уникальный UUID для этого кластера Пример: 86246a4d-a16c-4a58-9e96ad7719fe0f9d
id строка		При успехе, когда состояние равно 'present'	UUID кластера. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом 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.9/modules/os_coe_cluster_module.html