community.kubevirt.kubevirt_template – Управление шаблонами KubeVirt
Примечание
Этот плагин является частью коллекции community.kubevirt (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.kubevirt
Чтобы использовать его в плейбуке, укажите: community.kubevirt.kubevirt_template
Обзор
- Используйте Openshift Python SDK для управления состоянием шаблонов KubeVirt.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- openshift >= 0.8.2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка | Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY. | |
| ca_cert путь | Путь к сертификату CA, используемому для аутентификации с API. Необходимо предоставить весь цепочку сертификатов, чтобы избежать ошибок валидации сертификата. Также может быть задан через переменную окружения K8S_AUTH_SSL_CA_CERT. псевдонимы: ssl_ca_cert | |
| client_cert путь | Путь к сертификату, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_CERT_FILE. псевдонимы: cert_file | |
| client_key путь | Путь к файлу ключа, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_KEY_FILE. псевдонимы: key_file | |
| context строка | Имя контекста, найденного в файле конфигурации. Также может быть задан через переменную окружения K8S_AUTH_CONTEXT. | |
| default_disk словарь | Цель параметра default_disk — определить тип диска, поддерживаемый ОС, в основном с точки зрения шины (ide, scsi, sata, virtio, ...) Параметр default_disk определяет наложение конфигурации для дисков, которое будет применено поверх дисков во время создания виртуальной машины, чтобы определить общую совместимость и/или параметры производительности, определенные здесь.Этот параметр можно использовать только при установке плагина kubevirt на ваш кластер openshift. | |
| default_network словарь | Цель параметра default_network аналогична параметру default_volume и должна использоваться в качестве шаблона, который определяет параметры производительности и подключения (например, L2 мост) Параметр default_network определяет наложение конфигурации для сетей, которое будет применено поверх сетей во время создания виртуальной машины, чтобы определить общую совместимость и/или параметры производительности, определенные здесь.Этот параметр можно использовать только при установке плагина kubevirt на ваш кластер openshift. | |
| default_nic словарь | Цель параметра default_network аналогична параметру default_disk и должна использоваться в качестве шаблона для обеспечения совместимости ОС и производительности. Параметр default_nic определяет наложение конфигурации для nic, которое будет применено поверх сетевых адаптеров во время создания виртуальной машины, чтобы определить общую совместимость и/или параметры производительности, определенные здесь.Этот параметр можно использовать только при установке плагина kubevirt на ваш кластер openshift. | |
| default_volume словарь | Цель параметра default_volume — настройка, в основном, параметров производительности, таких как кеши, если они доступны для реализации подлежащего тома. Параметр default_volume определяет наложение конфигурации для томов, которое будет применено поверх томов во время создания виртуальной машины, чтобы определить общую совместимость и/или параметры производительности, определенные здесь.Этот параметр можно использовать только при установке плагина kubevirt на ваш кластер openshift. | |
| description строка | Описание шаблона. Включайте достаточно подробную информацию, чтобы пользователь понял, что развертывается… и любые оговорки, которые ему нужно знать перед развертыванием. Также следует предоставить ссылки на дополнительную информацию, такую как файл README." | |
| display_name строка | Краткое, понятное имя, которое может использоваться пользовательскими интерфейсами. | |
| documentation_url строка | Ссылка на дополнительную документацию по шаблону. | |
| editable список / элементы=строка | Расширение для указания элементов, которые следует считать изменяемыми. Список селекторов jsonpath. Корень jsonpath — это объекты: элемент шаблона. Этот параметр можно использовать только при установке плагина kubevirt на ваш кластер openshift. | |
| force булево |
| Если установлено значение yes, и state имеет значение present, существующий объект будет заменён. |
| host строка | Укажите URL для доступа к API. Также может быть задан через переменную окружения K8S_AUTH_HOST. | |
| icon_class строка | Иконка, которая будет отображаться с вашим шаблоном в веб-консоли. При возможности выбирайте из существующих значков логотипов. Также вы можете использовать иконки из FontAwesome. В качестве альтернативы, предоставляйте иконки через кастомизацию CSS, которая может быть добавлена в кластер OpenShift Container Platform, использующий ваш шаблон. Вы должны указать класс иконки, который существует, иначе это помешает падению до универсальной иконки. | |
| kubeconfig путь | Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть задан через переменную окружения K8S_AUTH_KUBECONFIG. | |
| long_description строка | Дополнительное описание шаблона. Это может отображаться, например, каталогом служб. | |
| merge_type список / элементы=строка |
| Определяет, следует ли переопределить подход по умолчанию к слиянию заплаток определённым типом. По умолчанию обычно используется стратегическое слияние. |
| name строка / обязательный | Имя объекта шаблона. | |
| namespace строка / обязательный | Пространство имён, в котором существует объект шаблона. | |
| objects список / элементы=строка | Список любых допустимых API-объектов, таких как DeploymentConfig, Service и т. д. Объект будет создан точно так, как определено здесь, со значениями любых параметров, подставленными перед созданием. Определение этих объектов может ссылаться на параметры, определённые ранее. В списке также можно передавать вид VirtualMachine. При передаче VirtualMachine необходимо использовать структуру Ansible параметров, а не структуру API Kubernetes. Для получения более подробной информации ознакомьтесь с модулем community.kubevirt.kubevirt_vm и разделом ПРИМЕРЫ, где вы можете увидеть пример. | |
| parameters список / элементы=строка | Параметры позволяют пользователю предоставлять значения или генерировать их при создании шаблона. Затем это значение подставляется там, где упоминается параметр. Ссылки могут быть определены в любом поле в списке полей objects. Это полезно для генерации случайных паролей или предоставления пользователю имени хоста или другого значения, специфичного для пользователя, необходимого для настройки шаблона. Дополнительную информацию можно найти по адресу: https://docs.openshift.com/container-platform/3.6/dev_guide/templates.html#writing-parameters
| |
| password строка | Укажите пароль для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_PASSWORD. Обратитесь к описанию опции username для обсуждения случаев, когда эта опция применима. | |
| persist_config булево |
| Определяет, сохранять ли токен обновления конфигурации kube. Также может быть задан через переменную окружения K8S_AUTH_PERSIST_CONFIG. Когда контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой k8s python, но по умолчанию не сохраняется. В результате старый токен обновления может истечь, и следующая аутентификация может завершиться неудачей. Установка этого флага в значение true сообщит библиотеке k8s python о сохранении нового токена обновления в файл конфигурации kube. По умолчанию false. Обратите внимание, что текущая версия библиотеки k8s python пока не поддерживает установку этого флага в значение True. Исправление для этой библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169 |
| provider_display_name строка | Имя человека или организации, предоставляющей шаблон. | |
| proxy строка | URL HTTP-прокси, который необходимо использовать для подключения. Также может быть задан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не подхватывает типичные настройки прокси из окружения (например, HTTP_PROXY). | |
| state строка |
| Определяет, должен ли быть создан, изменён или удалён объект. При значении present, объект будет создан, если он ещё не существует. При значении absent, существующий объект будет удалён. При значении present, существующий объект будет изменён, если его атрибуты отличаются от тех, которые указаны с помощью resource_definition или src. |
| support_url строка | URL, где можно получить поддержку для шаблона. |
| Имя пользователя строка | Укажите имя пользователя для аутентификации с API. Также можно указать через переменную среды K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования аутентификации HTTP Basic. Если ваш кластер использует другой метод аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует изучить модуль k8s_auth, так как он может быть полезен. | |
| validate_certs булево |
| Нужно ли проверять сертификаты SSL сервера API. Также можно указать через переменную среды K8S_AUTH_VERIFY_SSL. Псевдонимы: verify_ssl |
| версия строка | Версия шаблона структуры. Этот параметр можно использовать только при установке дополнения kubevirt на ваш кластер openshift. |
Примечания
Примечание
- Клиент OpenShift Python оборачивает клиент K8s Python, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версии API и дополнительную информацию см. на странице https://github.com/openshift/openshift-restclient-python
- Чтобы избежать ошибок проверки сертификатов SSL, когда
validate_certsимеет значение Истина, полная цепочка сертификатов сервера API должна быть предоставлена черезca_certили в файле kubeconfig.
Примеры
- name: Create template 'mytemplate'
community.kubevirt.kubevirt_template:
state: present
name: myvmtemplate
namespace: templates
display_name: Generic cirros template
description: Basic cirros template
long_description: Verbose description of cirros template
provider_display_name: Just Be Cool, Inc.
documentation_url: http://theverycoolcompany.com
support_url: http://support.theverycoolcompany.com
icon_class: icon-linux
default_disk:
disk:
bus: virtio
default_nic:
model: virtio
default_network:
resource:
resourceName: bridge.network.kubevirt.io/cnvmgmt
default_volume:
containerDisk:
image: kubevirt/cirros-container-disk-demo:latest
objects:
- name: ${NAME}
kind: VirtualMachine
memory: ${MEMORY_SIZE}
state: present
namespace: vms
parameters:
- name: NAME
description: VM name
generate: expression
from: 'vm-[A-Za-z0-9]{8}'
- name: MEMORY_SIZE
description: Memory size
value: 1Gi
- name: Remove template 'myvmtemplate'
community.kubevirt.kubevirt_template:
state: absent
name: myvmtemplate
namespace: templates
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| kubevirt_template сложное | успех | Словарь шаблона, возвращенный API. |
Авторы
- Команда KubeVirt (@kubevirt)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/kubevirt/kubevirt_template_module.html