Модуль openstack.cloud.coe_cluster_template — управление шаблоном кластера COE в OpenStack Cloud

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

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

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

fixed_subnet

string

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

flavor_id

string

Конфигурация узла minion для этого шаблона кластера.

http_proxy

string

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

Формат — URL с номером порта.

https_proxy

string

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

Формат — URL с номером порта.

image_id

string

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

Обязательный параметр, если state имеет значение present.

insecure_registry

string

URL собственного частного небезопасного реестра Docker пользователя.

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 ← (по умолчанию)

is_master_lb_enabled

aliases: master_lb_enabled

boolean

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

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

Допустимые значения:

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

is_public

aliases: public

boolean

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

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

Допустимые значения:

• false
• true

is_registry_enabled

aliases: registry_enabled

boolean

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

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

Допустимые значения:

• false
• true

is_tls_disabled

aliases: tls_disabled

boolean

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

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

Допустимые значения:

• false
• true

keypair_id

string

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

labels

any

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

master_flavor_id

string

Конфигурация главного узла для этого шаблона кластера.

name

string / обязательный

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

network_driver

string

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

Допустимые значения:

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

no_proxy

string

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

region_name

string

Название региона.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Допустимые значения:

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

sdk_log_path

string

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

server_type

string

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

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

Допустимые значения:

• "vm"
• "bm"

state

string

Желаемое состояние ресурса.

Допустимые значения:

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

timeout

integer

Время, в течение которого Ansible ожидает запрошенный ресурс.

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

validate_certs

aliases: verify

boolean

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

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

Допустимые значения:

• false
• true

volume_driver

string

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

Допустимые значения:

• "cinder"
• "rexray"

wait

boolean

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

Допустимые значения:

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

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

Название или идентификатор сети Neutron, обеспечивающей bay/cluster подключение к внешнему Интернету.

Возвращается: при успешном выполнении

Пример: "public"

fixed_network

string

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

Возвращается: при успешном выполнении

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

fixed_subnet

string

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

Возвращается: при успешном выполнении

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

flavor_id

string

Идентификатор или название flavor 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-адрес.

Возвращается: при успешном выполнении

Пример: true

is_hidden

boolean

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

Возвращается: при успешном выполнении

Пример: false

is_master_lb_enabled

boolean

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

Возвращается: при успешном выполнении

Пример: true

is_public

boolean

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

Возвращается: при успешном выполнении

Пример: false

is_registry_enabled

boolean

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

Возвращается: при успешном выполнении

Пример: false

is_tls_disabled

boolean

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

Возвращается: при успешном выполнении

Пример: false

keypair_id

string

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

Возвращается: при успешном выполнении

Пример: "mykey"

labels

dictionary

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

Возвращается: при успешном выполнении

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

master_flavor_id

string

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

Возвращается: при успешном выполнении

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

name

string

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

Возвращается: при успешном выполнении

Пример: "k8scluster"

network_driver

string

Название сетевого драйвера, обеспечивающего работу сетей контейнеров

Возвращается: при успешном выполнении

Пример: "calico"

no_proxy

string

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

Возвращается: при успешном выполнении

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

server_type

string

Серверами в bay/cluster могут быть виртуальные машины или физические серверы.

Возвращается: при успешном выполнении

Пример: "vm"

updated_at

string

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

Возвращается: при успешном выполнении

uuid

string

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

Возвращается: при успешном выполнении

volume_driver

string

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

Возвращается: при успешном выполнении

Пример: "cinder"