Spec-Zone.ru › Ansible 2.7

k8s_scale – Установка нового размера для Deployment, ReplicaSet, Replication Controller или Job.

Новая версия 2.5.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Краткое описание

  • Аналогично команде kubectl scale. Используется для установки количества реплик для Deployment, ReplicatSet или Replication Controller, или атрибута параллелизма для Job. Поддерживает режим проверки.

Псевдонимы: openshift_scale

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • openshift >= 0.6
  • PyYAML >= 3.11

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_key
-
Токен, используемый для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_API_KEY.
api_version
-
По умолчанию:
"v1"
Используется для указания версии API. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с kind, name и namespace для идентификации конкретного объекта. Если предоставлено resource definition, apiVersion из resource_definition переопределит этот параметр.

псевдонимы: api, version
cert_file
-
Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_CERT_FILE.
context
-
Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную среды K8S_AUTH_CONTEXT.
current_replicas
целое число
Только для Deployment, ReplicaSet, Replication Controller масштабировать, если количество существующих реплик совпадает. В случае с Job, обновление параллелизма только если текущее значение параллелизма совпадает.
host
-
Укажите URL для доступа к API. Также может быть указан через переменную среды K8S_AUTH_HOST.
key_file
-
Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_HOST.
kind
-
Используется для указания модели объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, name и namespace для идентификации конкретного объекта. Если предоставлено resource definition, kind из resource_definition переопределит этот параметр.
kubeconfig
-
Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную среды K8S_AUTH_KUBECONFIG.
name
-
Используется для указания имени объекта. Используется для создания, удаления или поиска объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, kind и namespace для идентификации конкретного объекта. Если предоставлено resource definition, значение metadata.name из resource_definition переопределит этот параметр.
namespace
-
Используется для указания пространства имен объекта. Полезно при создании, удалении или поиске объекта без предоставления полного определения ресурса. Используется в сочетании с api_version, kind и name для идентификации конкретного объекта. Если предоставлено resource definition, значение metadata.namespace из resource_definition переопределит этот параметр.
password
-
Укажите пароль для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_PASSWORD.
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. Смотрите Примеры ниже.
ssl_ca_cert
-
Путь к сертификату CA, используемому для аутентификации с API. Полная цепочка сертификатов должна быть предоставлена для предотвращения ошибок проверки сертификатов. Также может быть указан через переменную среды K8S_AUTH_SSL_CA_CERT.
username
-
Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную среды K8S_AUTH_USERNAME.
verify_ssl
логическое
    Варианты:
  • нет
  • да
Требуется ли проверка сертификатов SSL сервера API. Также может быть указан через переменную среды K8S_AUTH_VERIFY_SSL.
wait
логическое
    Варианты:
  • нет
  • да ←
Для Deployment, ReplicaSet, Replication Controller ожидать, пока значение status 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-сертификатов, когда verify_ssl True, полная цепочка сертификатов для сервера API должна быть предоставлена через ssl_ca_cert или в файле kubeconfig.

Примеры

- name: Scale deployment up, and extend timeout
  k8s_scale:
    api_version: v1
    kind: Deployment
    name: elastic
    namespace: myproject
    replicas: 3
    wait_timeout: 60

- name: Scale deployment down when current replicas match
  k8s_scale:
    api_version: v1
    kind: Deployment
    name: elastic
    namespace: myproject
    current_replicas: 3
    replicas: 2

- name: Increase job parallelism
  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
  k8s_scale:
    src: /myproject/elastic_deployment.yml
    replicas: 3
    wait: no

- name: Scale deployment based on a template output
  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
  k8s_scale:
    resource_definition: "{{ lookup('file', '/myproject/elastic_deployment.yml') | from_yaml }}"
    replicas: 3
    wait: no

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

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

Ключ Возвращаемое значение Описание
result
complex
success
Если изменения были внесены, возвращается измененный объект; в противном случае возвращается существующий объект.

api_version
string
success
Версия схемы этого представления объекта.

kind
string
success
Представляет REST-ресурс, который представляет этот объект.

metadata
complex
success
Стандартные метаданные объекта. Включают имя, пространство имен, аннотации, метки и т. д.

spec
complex
success
Конкретные атрибуты объекта. Будут различаться в зависимости от api_version и kind.

status
complex
success
Текущие сведения о состоянии объекта.



Состояние

  • Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.7/modules/k8s_scale_module.html

Spec-Zone.ru

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