Модуль openstack.cloud.coe_cluster — управление кластером COE в OpenStack Cloud
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в сценарии, укажите: openstack.cloud.coe_cluster.
Краткое описание
- Добавление или удаление кластера COE (Container Orchestration Engine) с помощью API Magnum в OpenStack (также известного как API управления инфраструктурой контейнеров).
Требования
На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Время ожидания сокетного уровня перед истечением времени ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не будет передано. |
auth dictionary | Словарь с данными аутентификации, необходимыми для используемой облаком стратегии плагина аутентификации. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или доступны переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не аутентификацию по паролю, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому в транзакции SSL. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому в транзакции SSL. |
cloud any | Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или доступны переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
cluster_template_id string | Идентификатор шаблона кластера. Обязателен, если state имеет значение |
discovery_url string | URL-адрес, используемый для обнаружения узлов кластера. |
flavor_id string | Тип узла minion для этого шаблона кластера. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, извлекаемой из каталога служб. Допустимые значения:
|
is_floating_ip_enabled псевдонимы: floating_ip_enabled boolean | Указывает, должен ли создаваемый кластер иметь плавающий IP-адрес. Определяет, использовать ли плавающий IP-адрес облачного провайдера. Некоторые облачные провайдеры используют плавающие IP-адреса, другие — публичные IP-адреса; поэтому Magnum предоставляет этот параметр для выбора способа использования IP-адреса. Если значение не задано, используется значение is_floating_ip_enabled шаблона кластера, указанного в cluster_template_id. Если для is_floating_ip_enabled задано значение Допустимые значения:
|
keypair string | Имя используемой пары ключей. |
labels any | Одна или несколько пар «ключ/значение». |
master_count integer | Количество главных узлов в этом кластере. Значение master_count по умолчанию для Magnum — 1. |
master_flavor_id string | Тип главного узла для этого шаблона кластера. |
name string / обязательный | Имя, которое будет присвоено шаблону кластера. |
node_count integer | Количество узлов в этом кластере. Значение node_count по умолчанию для Magnum — 1. |
region_name string | Название региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Допустимые значения:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
state string | Требуемое состояние ресурса. Допустимые значения:
|
timeout integer | Время, в течение которого Ansible ожидает запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было Допустимые значения:
|
wait boolean | Следует ли Ansible ожидать завершения создания запрошенного ресурса. Допустимые значения:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk, поэтому значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительные сведения см. на странице 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 dictionary | Словарь с описанием кластера. Возвращается: при успешном выполнении, если значение state — |
|
api_address string |
URL конечной точки API COE, доступной конечным пользователям. Возвращается: при успешном выполнении Пример: |
|
cluster_template_id string |
UUID шаблона кластера. Возвращается: при успешном выполнении Пример: |
|
coe_version string |
Информация о версии выбранной COE в bay/cluster, помогающая клиенту выбрать подходящую версию клиента. Возвращается: при успешном выполнении Пример: |
|
create_timeout integer |
Время ожидания создания кластера в минутах. Если значение не задано, используется 60 минут. Возвращается: при успешном выполнении Пример: |
|
created_at string |
Дата и время создания кластера в формате UTC. Возвращается: при успешном выполнении Пример: |
|
discovery_url string |
Пользовательский URL обнаружения узлов. COE использует его для обнаружения серверов, созданных для размещения контейнеров. Фактический механизм обнаружения зависит от COE. В некоторых случаях служба передает сведения о сервере в службу обнаружения. В других случаях, если discovery_url не указан, служба использует общедоступную службу обнаружения по адресу https://discovery.etcd.io. В этом случае служба создает здесь уникальный URL для каждого bay и сохраняет сведения о серверах. Возвращается: при успешном выполнении Пример: |
|
fixed_network string |
Имя или идентификатор сети, обеспечивающей подключение к внутренней сети bay/cluster. Возвращается: при успешном выполнении |
|
fixed_subnet string |
Фиксированная подсеть, используемая при выделении сетевых адресов узлам в bay/cluster. Возвращается: при успешном выполнении |
|
flavor_id string |
Имя или идентификатор flavor, используемого при запуске серверов узлов. По умолчанию — m1.small. Возвращается: при успешном выполнении |
|
id string |
Уникальный UUID этого кластера. Возвращается: при успешном выполнении Пример: |
|
is_floating_ip_enabled boolean |
Указывает, должны ли у созданных кластеров быть плавающие IP-адреса. Возвращается: при успешном выполнении Пример: |
|
is_master_lb_enabled boolean |
Указывает, должен ли у созданных кластеров быть балансировщик нагрузки для главных узлов. Возвращается: при успешном выполнении Пример: |
|
keypair string |
Имя используемой пары ключей. Возвращается: при успешном выполнении Пример: |
|
labels dictionary |
Одна или несколько пар «ключ/значение». Возвращается: при успешном выполнении Пример: |
|
master_addresses list / elements=string |
Список плавающих IP-адресов всех главных узлов. Возвращается: при успешном выполнении Пример: |
|
master_count integer |
Количество серверов, которые будут выполнять роль главных узлов для bay/cluster. Чтобы включить высокую доступность, задайте значение больше 1. Если в модели bay/шаблоне кластера указана опция master-lb-enabled, главные серверы будут помещены в пул балансировщика нагрузки. По умолчанию — 1. Возвращается: при успешном выполнении Пример: |
|
master_flavor_id string |
Flavor главного узла для этой модели bay/шаблона кластера. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя, которое необходимо присвоить кластеру. Возвращается: при успешном выполнении Пример: |
|
node_addresses list / elements=string |
Список плавающих IP-адресов всех серверов, выполняющих роль узлов. Возвращается: при успешном выполнении Пример: |
|
node_count integer |
Количество главных узлов в этом кластере. Возвращается: при успешном выполнении Пример: |
|
stack_id string |
Ссылочный UUID стека оркестрации из службы оркестрации Heat. Возвращается: при успешном выполнении Пример: |
|
status string |
Статус кластера, полученный из стека Heat. Возвращается: при успешном выполнении Пример: |
|
status_reason string |
Причина текущего статуса кластера, полученная из стека Heat. Возвращается: при успешном выполнении Пример: |
|
updated_at string |
Дата и время последнего обновления кластера в формате UTC. Возвращается: при успешном выполнении Пример: |
|
uuid string |
Уникальный UUID этого кластера. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/coe_cluster_module.html