Spec-Zone.ru › Ansible

openstack.cloud.coe_cluster модуль — Управление кластером COE в OpenStack Cloud

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: openstack.cloud.coe_cluster.

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

Описание

  • Добавление или удаление кластера COE (Container Orchestration Engine) через API Magnum (Container Infrastructure Management) OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Сколько времени должен ждать уровень сокета, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.

auth

dictionary

Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для подключаемого модуля password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать все параметры, которые требуются этому подключаемому модулю аутентификации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.

auth_type

string

Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом.

ca_cert

aliases: cacert

string

Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов API SSL.

client_cert

aliases: cert

string

Путь к клиентскому сертификату, который будет использоваться как часть транзакции SSL.

client_key

aliases: key

string

Путь к клиентскому ключу, который будет использоваться как часть транзакции SSL.

cloud

any

Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — это строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.

cluster_template_id

string

ID шаблона кластера.

Обязательно, если state — это present.

discovery_url

string

URL, используемый для обнаружения узлов кластера.

flavor_id

string

Вкус узла подчиненного для этого шаблона кластера.

interface

aliases: endpoint_type

string

Тип URL конечной точки для извлечения из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

is_floating_ip_enabled

aliases: floating_ip_enabled

boolean

Указывает, должен ли созданный кластер иметь плавающий IP.

Включать или нет использование плавающего IP-адреса поставщика облачных услуг. Некоторые поставщики облачных услуг используют плавающие IP-адреса, некоторые — общедоступные IP-адреса, поэтому Magnum предоставляет эту опцию для указания выбора использования плавающего IP-адреса.

Если не задано, будет использовано значение is_floating_ip_enabled шаблона кластера, указанного с помощью cluster_template_id.

Когда is_floating_ip_enabled установлено в true, то external_network_id в шаблоне кластера должен быть определен.

Варианты:

  • false
  • true

keypair

string

Имя пары ключей для использования.

labels

any

Одна или несколько пар ключ/значение.

master_count

integer

Количество ведущих узлов для этого кластера.

Значение по умолчанию для master_count в Magnum равно 1.

master_flavor_id

string

Вкус ведущего узла для этого шаблона кластера.

name

string / required

Имя, которое должно быть присвоено шаблону кластера.

node_count

integer

Количество узлов для этого кластера.

Значение по умолчанию для node_count в Magnum равно 1.

region_name

string

Имя региона.

sdk_log_level

string

Уровень логирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается

state

string

Указывает желаемое состояние ресурса.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Сколько времени Ansible должен ждать запрашиваемого ресурса.

По умолчанию: 180

validate_certs

aliases: verify

boolean

Нужно ли проверять запросы API SSL.

До Ansible 2.3 по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ждать завершения запрошенного ресурса.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явного указания значений.
  • Информация об авторизации задается openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в play. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Create a new Kubernetes cluster
  openstack.cloud.coe_cluster:
    cloud: devstack
    cluster_template_id: k8s-ha
    keypair: mykey
    master_count: 3
    name: k8s
    node_count: 5

Значения возврата

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

Ключ

Описание

cluster

словарь

Словарь, описывающий кластер.

Возвращается: При успехе, когда state равно present.

api_address

строка

URL конечной точки API COE, доступной конечным пользователям.

Возвращается: успех

Пример: "https://172.24.4.30:6443"

cluster_template_id

строка

UUID шаблона кластера.

Возвращается: успех

Пример: "7b1418c8-cea8-48fc-995d-52b66af9a9aa"

coe_version

строка

Информация о версии выбранного COE в заливе/кластере, помогающая клиенту выбрать правильную версию клиента.

Возвращается: успех

Пример: "v1.11.1"

create_timeout

целое число

Таймаут создания кластера в минутах. По умолчанию 60, если не указано.

Возвращается: успех

Пример: 60

created_at

строка

Дата и время UTC создания кластера.

Возвращается: успех

Пример: "2018-08-16T10:29:45+00:00"

discovery_url

строка

Настраиваемый URL для обнаружения узлов. Используется COE для обнаружения серверов, созданных для размещения контейнеров. Механизм обнаружения зависит от COE. В некоторых случаях сервис заполняет информацию о серверах в сервисе обнаружения. В других случаях, если discovery_url не указан, сервис использует общедоступный сервис обнаружения по адресу https://discovery.etcd.io. В этом случае сервис генерирует уникальный URL для каждого залива и сохраняет информацию о серверах.

Возвращается: успех

Пример: "https://discovery.etcd.io/a42ee38e7113f31f4d6324f24367aae5"

fixed_network

строка

Имя или ID сети для подключения к внутренней сети залива/кластера.

Возвращается: успех

fixed_subnet

строка

Фиксированный подсеть для использования при выделении сетевых адресов узлам в заливе/кластере.

Возвращается: успех

flavor_id

строка

Имя или ID виртуальной машины для загрузки узловых серверов. По умолчанию m1.small.

Возвращается: успех

id

строка

Уникальный UUID для этого кластера.

Возвращается: успех

Пример: "86246a4d-a16c-4a58-9e96ad7719fe0f9d"

is_floating_ip_enabled

булево

Указывает, должны ли созданные кластеры иметь плавающий IP-адрес или нет.

Возвращается: успех

Пример: true

is_master_lb_enabled

булево

Указывает, должны ли созданные кластеры иметь балансировщик нагрузки для мастер-узлов или нет.

Возвращается: успех

Пример: true

keypair

строка

Имя пары ключей для использования.

Возвращается: успех

Пример: "mykey"

labels

словарь

Одна или несколько пар ключ/значение.

Возвращается: успех

Пример: {"key1": "value1", "key2": "value2"}

master_addresses

список / элементы=строка

Список плавающих IP-адресов всех мастер-узлов.

Возвращается: успех

Пример: ["172.24.4.5"]

master_count

целое число

Количество серверов, которые будут выполнять роль master для кластера. Установите значение больше 1, чтобы включить высокодоступность. Если в шаблоне baymodel/cluster указан параметр master-lb-enabled, серверы master будут размещены в пуле балансировщиков нагрузки. По умолчанию значение равно 1.

Возвращается: успех

Пример: 1

master_flavor_id

строка

Flavor узла master для данного шаблона baymodel/cluster.

Возвращается: успех

Пример: "c1.c1r1"

name

строка

Имя, которое необходимо присвоить кластеру.

Возвращается: успех

Пример: "k8scluster"

node_addresses

список / элементы=строка

Список адресов floating IP всех серверов, которые выступают в роли узлов.

Возвращается: успех

Пример: ["172.24.4.8"]

node_count

целое число

Количество узлов master для данного кластера.

Возвращается: успех

Пример: 1

stack_id

строка

Уникальный UUID стека оркестрации из сервиса Heat оркестрации.

Возвращается: успех

Пример: "07767ec6-85f5-44cb-bd63-242a8e7f0d9d"

status

строка

Статус кластера из стека Heat.

Возвращается: успех

Пример: "CREATE_COMLETE"

status_reason

строка

Причина статуса кластера из стека Heat

Возвращается: успех

Пример: "Stack CREATE completed successfully"

updated_at

строка

Дата и время обновления кластера в формате UTC.

Возвращается: успех

Пример: "2018-08-16T10:39:25+00:00"

uuid

строка

Уникальный UUID данного кластера.

Возвращается: успех

Пример: "86246a4d-a16c-4a58-9e96ad7719fe0f9d"

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/coe_cluster_module.html

Spec-Zone.ru

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