Spec-Zone.ru › Ansible

openstack.cloud.coe_cluster_template модуль — Управление шаблоном кластера 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_template.

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

Описание

  • Добавление или удаление шаблона кластера 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.

coe

string

Движок контейнерной оркестровки для этого шаблона кластера

Требуется, если state — present.

Варианты:

  • "kubernetes"
  • "swarm"
  • "mesos"

dns_nameserver

string

Адрес DNS-сервера.

Значение по умолчанию для dns_nameserver в Magnum — 8.8.8.8.

docker_storage_driver

string

Драйвер хранилища Docker.

Варианты:

  • "devicemapper"
  • "overlay"
  • "overlay2"

docker_volume_size

integer

Размер в ГБ тома Docker.

external_network_id

string

Внешняя сеть для подключения к кластеру.

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

fixed_network

string

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

fixed_subnet

string

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

flavor_id

string

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

http_proxy

string

Адрес прокси-сервера, который будет получать все HTTP-запросы и пересылать их.

Формат — URL, включая номер порта.

https_proxy

string

Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их.

Формат — URL, включая номер порта.

image_id

string

ID образа, на основе которого будет создан кластер.

Требуется, если state — present.

interface

aliases: endpoint_type

string

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

Варианты:

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

is_floating_ip_enabled

aliases: floating_ip_enabled

boolean

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

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

Варианты:

  • false
  • true ← (default)

is_master_lb_enabled

aliases: master_lb_enabled

boolean

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

Значение по умолчанию в Magnum для is_master_lb_enabled — true, наше — false.

Варианты:

  • false ← (default)
  • true

is_public

aliases: public

boolean

Указывает, является ли шаблон кластера общедоступным или нет.

Значение по умолчанию в Magnum для is_public — false.

Варианты:

  • false
  • true

is_registry_enabled

aliases: registry_enabled

boolean

Указывает, включен ли реестр Docker.

Значение по умолчанию в Magnum для is_registry_enabled — false.

Варианты:

  • false
  • true

is_tls_disabled

aliases: tls_disabled

boolean

Указывает, следует ли отключить TLS.

Значение по умолчанию в Magnum для is_tls_disabled — false.

Варианты:

  • false
  • true

keypair_id

string

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

labels

any

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

master_flavor_id

string

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

name

string / required

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

network_driver

string

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

Варианты:

  • "flannel"
  • "calico"
  • "docker"

no_proxy

string

Список IP-адресов, разделенных запятыми, для которых прокси не должны использоваться в кластере.

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

  • "INFO" ← (default)
  • "DEBUG"

sdk_log_path

string

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

server_type

string

Тип сервера для этого шаблона кластера.

Значение по умолчанию в Magnum для server_type — vm.

Варианты:

  • "vm"
  • "bm"

state

string

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

Варианты:

  • "present" ← (default)
  • "absent"

timeout

integer

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

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

validate_certs

aliases: verify

boolean

Проверка SSL-запросов API.

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

Возможные значения:

  • false
  • true

volume_driver

string

Имя драйвера, используемого для инициализации объёмов контейнера.

Возможные значения:

  • "cinder"
  • "rexray"

wait

boolean

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

Возможные значения:

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

Примечания

Примечание

  • Можно использовать стандартные переменные окружения 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 template
  openstack.cloud.coe_cluster_template:
    cloud: devstack
    coe: kubernetes
    image_id: 2a8c9888-9054-4b06-a1ca-2bb61f9adb72
    keypair_id: mykey
    name: k8s
    is_public: false

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

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

Ключ

Описание

cluster_template

dictionary

Словарь, описывающий шаблон.

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

apiserver_port

integer

Открытый порт сервера API COE.

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

cluster_distro

string

Отображает атрибут os_distro, определенный как соответствующие метаданные в образе для драйвера bay/cluster.

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

coe

string

Движок оркестровки контейнеров для этого шаблона кластера. Поддерживаемые COE включают kubernetes, swarm, mesos.

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

Пример: "kubernetes"

created_at

string

Дата и время создания ресурса.

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

dns_nameserver

string

DNS-сервер имен для серверов и контейнеров в bay/cluster.

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

Пример: "8.8.8.8"

docker_storage_driver

string

Имя драйвера для управления хранилищем образов и записываемого слоя контейнера.

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

docker_volume_size

integer

Размер в ГБ локального хранилища на каждом сервере для кэширования образов и размещения контейнеров демоном Docker.

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

Пример: 5

external_network_id

string

Имя или ID сети Neutron для обеспечения подключения к внешнему интернету для bay/cluster.

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

Пример: "public"

fixed_network

string

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

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

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

fixed_subnet

string

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

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

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

flavor_id

string

ID или имя образа Nova для загрузки узловых серверов.

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

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

http_proxy

string

Адрес прокси-сервера, который будет принимать все HTTP-запросы и передавать их. Формат — URL, включая номер порта.

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

Пример: "http://10.0.0.11:9090"

https_proxy

string

Адрес прокси-сервера, который будет принимать все HTTPS-запросы и передавать их. Формат — URL, включая номер порта.

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

Пример: "https://10.0.0.10:8443"

id

string

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

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

image_id

string

Имя или UUID базового образа в Glance для загрузки серверов для bay/cluster.

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

Пример: "05567ec6-85f5-44cb-bd63-242a8e7f0e9d"

insecure_registry

string

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

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

is_floating_ip_enabled

boolean

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

Возвращено: success

Пример: true

is_hidden

boolean

Указывает, скрыт шаблон кластера или нет.

Возвращено: success

Пример: false

is_master_lb_enabled

boolean

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

Возвращено: success

Пример: true

is_public

boolean

Доступ к шаблону baymodel/cluster обычно ограничен администратором, владельцем или пользователями того же арендатора, что и владельцы. Установка этого флага делает шаблон baymodel/cluster общедоступным и доступным для других пользователей. По умолчанию он не является общедоступным.

Возвращено: success

Пример: false

is_registry_enabled

boolean

Образы Docker по умолчанию извлекаются из общедоступного реестра Docker, но в некоторых случаях пользователи могут захотеть использовать частный реестр. Эта опция предоставляет альтернативный реестр на основе Registry V2: Magnum создаст локальный реестр в bay/cluster на основе swift для размещения образов. По умолчанию используется общедоступный реестр.

Возвращено: success

Пример: false

is_tls_disabled

boolean

Транспортная защита (TLS) обычно включена для защиты bay/cluster. В некоторых случаях пользователи могут захотеть отключить TLS в bay/cluster, например, во время разработки или для устранения неполадок. Указание этого параметра отключит TLS, чтобы пользователи могли получать доступ к конечным точкам COE без сертификата. По умолчанию TLS включен.

Возвращено: success

Пример: false

keypair_id

string

Имя пары ключей SSH для настройки на серверах bay/cluster для доступа по ssh.

Возвращено: success

Пример: "mykey"

labels

dictionary

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

Возвращено: success

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

master_flavor_id

string

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

Возвращено: success

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

name

string

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

Возвращено: success

Пример: "k8scluster"

network_driver

string

Имя сетевого драйвера для предоставления сетей для контейнеров

Возвращено: success

Пример: "calico"

no_proxy

string

Список IP-адресов, разделенных запятыми, для которых прокси-серверы не должны использоваться в кластере.

Возвращено: success

Пример: "10.0.0.4,10.0.0.5"

server_type

string

Серверы в bay/cluster могут быть виртуальными машинами или baremetal.

Возвращено: success

Пример: "vm"

updated_at

string

Дата и время обновления ресурса.

Возвращено: success

uuid

string

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

Возвращено: success

volume_driver

string

Имя драйвера томов для управления постоянным хранилищем для контейнеров.

Возвращено: success

Пример: "cinder"

Авторы

  • 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_template_module.html

Spec-Zone.ru

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