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

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

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

Обзор

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

Требования

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

openstacksdk
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, который может использоваться для проверки запросов 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.
cluster_template_id - / обязательно		Идентификатор шаблона кластера.
discovery_url -		URL, используемый для обнаружения узлов кластера.
docker_volume_size -		Размер тома Docker в ГБ.
flavor_id -		Тип виртуальной машины (flavor) узла-подчинённого для этого шаблона кластера.
interface строка добавлен в 2.3	Варианты: 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	Требуется ли проверка запросов API SSL. До 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, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Более подробная информация доступна по адресу 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 строка		Уникальный идентификатор шаблона кластера Пример: 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 строка		Тип виртуальной машины узел-клиент для этого кластера Пример: 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-адреса узлов-клиентов кластера Пример: ['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'	Уникальный идентификатор кластера. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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_module.html