community.kubernetes.k8s_scale – Установка нового размера для Deployment, ReplicaSet, Replication Controller или Job.
Примечание
Этот плагин входит в состав коллекции community.kubernetes (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.kubernetes.
Для использования в плейбуке укажите: community.kubernetes.k8s_scale.
Обзор
- Аналогичен команде kubectl scale. Используется для установки количества реплик для Deployment, ReplicaSet или Replication Controller, или атрибута параллелизма для Job. Поддерживает режим проверки.
Примечание
У данного модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- openshift >= 0.6
- PyYAML >= 3.11
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка | Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY. | |
| api_version строка | По умолчанию: "v1" | Используется для указания версии API. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с kind, name и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение apiVersion из resource_definition переопределит этот параметр. псевдонимы: api, version |
| 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. | |
| current_replicas целое число | Для Deployment, ReplicaSet, Replication Controller, масштабирование выполняется только если число существующих реплик совпадает. В случае с Job, обновляется параллелизм только если текущее значение параллелизма совпадает. | |
| host строка | Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST. | |
| kind строка | Используется для указания модели объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, name и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение kind из resource_definition переопределит этот параметр. | |
| kubeconfig путь | Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. | |
| name строка | Используется для указания имени объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, kind и namespace для идентификации конкретного объекта. Если предоставлено определение ресурса, значение metadata.name из resource_definition переопределит этот параметр. | |
| namespace строка | Используется для указания пространства имен объекта. Полезно при создании, удалении или поиске объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, kind и name для идентификации конкретного объекта. Если предоставлено определение ресурса, значение metadata.namespace из resource_definition переопределит этот параметр. | |
| 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 |
| proxy строка | URL HTTP-прокси, который следует использовать для подключения. Также может быть указан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не подхватывает стандартные настройки прокси из окружения (например, HTTP_PROXY). | |
| replicas целое число / обязательно | Желаемое количество реплик. | |
| resource_definition строка | Укажите допустимое YAML-определение (в виде строки, списка или словаря) для объекта при создании или обновлении. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в предоставленном resource_definition. псевдонимы: definition, inline | |
| resource_version строка | Попытка масштабирования выполняется только если текущая версия объекта совпадает. | |
| src путь | Укажите путь к файлу, содержащему допустимое YAML-определение объекта или объектов, которые необходимо создать или обновить. Взаимоисключающий с resource_definition. ПРИМЕЧАНИЕ: kind, api_version, name и namespace будут перезаписаны соответствующими значениями, найденными в конфигурации, прочитанной из файла src. Читает из локальной файловой системы. Чтобы читать из файловой системы контроллера Ansible, включая зашифрованные файлы, используйте плагин поиска файлов или плагин поиска шаблонов, в сочетании с фильтром from_yaml, и передайте результат в resource_definition. См. примеры ниже. Взаимоисключающий с template в случае модуля k8s. | |
| username строка | Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер использует другой метод аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует изучить модуль k8s_auth, поскольку он может быть более подходящим. | |
| validate_certs булево |
| Проверять ли SSL-сертификаты сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl |
| wait булево |
| Для Deployment, ReplicaSet, Replication Controller, ожидать изменения статуса ready_replicas на значение replicas. В случае с Job этот параметр игнорируется. |
| wait_timeout целое число | По умолчанию: 20 | Если wait равен True, количество секунд ожидания статуса ready_replicas, равного replicas. Если статус не достигнут в отведенное время, произойдет ошибка. В случае с Job этот параметр игнорируется. |
Примечания
Примечание
- Клиент OpenShift для Python оборачивает K8s Python-клиент, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версиях API и дополнительную информацию см. на странице https://github.com/openshift/openshift-restclient-python
- Чтобы избежать ошибок проверки SSL-сертификатов, когда
validate_certsравно True, полную цепочку сертификатов для сервера API необходимо предоставить черезca_certили в файле kubeconfig.
Примеры
- name: Scale deployment up, and extend timeout
community.kubernetes.k8s_scale:
api_version: v1
kind: Deployment
name: elastic
namespace: myproject
replicas: 3
wait_timeout: 60
- name: Scale deployment down when current replicas match
community.kubernetes.k8s_scale:
api_version: v1
kind: Deployment
name: elastic
namespace: myproject
current_replicas: 3
replicas: 2
- name: Increase job parallelism
community.kubernetes.k8s_scale:
api_version: batch/v1
kind: job
name: pi-with-timeout
namespace: testing
replicas: 2
# Match object using local file or inline definition
- name: Scale deployment based on a file from the local filesystem
community.kubernetes.k8s_scale:
src: /myproject/elastic_deployment.yml
replicas: 3
wait: no
- name: Scale deployment based on a template output
community.kubernetes.k8s_scale:
resource_definition: "{{ lookup('template', '/myproject/elastic_deployment.yml') | from_yaml }}"
replicas: 3
wait: no
- name: Scale deployment based on a file from the Ansible controller filesystem
community.kubernetes.k8s_scale:
resource_definition: "{{ lookup('file', '/myproject/elastic_deployment.yml') | from_yaml }}"
replicas: 3
wait: no
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращается | Описание | |
|---|---|---|---|
| result complex | успех | Если изменения были внесены, возвращается измененный объект, в противном случае возвращается существующий объект. | |
| api_version строка | успех | Версионированная схема этого представления объекта. | |
| duration целое число | когда wait равно true | время выполнения задачи в секундах Пример: 48 | |
| kind строка | успех | Представляет REST-ресурс, который представляет этот объект. | |
| metadata complex | успех | Стандартные метаданные объекта. Включают имя, пространство имен, аннотации, метки и т. д. | |
| spec complex | успех | Уникальные атрибуты объекта. Будут различаться в зависимости от api_version и kind. | |
| status complex | успех | Текущие сведения о состоянии объекта. | |
Авторы
- Chris Houseknecht (@chouseknecht)
- Fabian von Feilitzsch (@fabianvf)
© 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/kubernetes/k8s_scale_module.html
