Модуль kubernetes.core.k8s_scale — задать новый размер Deployment, ReplicaSet, Replication Controller или Job.

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install kubernetes.core. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать этот модуль в playbook, укажите: kubernetes.core.k8s_scale.

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

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

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

Примечание

Этому модулю соответствует модуль действия.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.9
kubernetes >= 24.2.0
PyYAML >= 3.11

Параметры

Параметр	Комментарии
api_key string	Токен для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.
api_version псевдонимы: api, version string	Указывает версию API. Используется для создания, удаления или обнаружения объекта без предоставления полного описания ресурса. Используется совместно с kind, name и namespace для идентификации конкретного объекта. Если указано описание ресурса, значение apiVersion из resource_definition переопределит этот параметр. По умолчанию: `"v1"`
ca_cert псевдонимы: ssl_ca_cert path	Путь к сертификату CA для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо предоставить полную цепочку сертификатов. Также можно задать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file path	Путь к сертификату для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file path	Путь к файлу ключа для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_KEY_FILE.
context string	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
continue_on_error boolean добавлено в kubernetes.core 2.0.0	Продолжать ли выполнение при возникновении ошибок, если задано несколько ресурсов. Варианты: `false` ← (по умолчанию) `true`
current_replicas integer	Для Deployment, ReplicaSet и Replication Controller масштабирование выполняется только в том случае, если число существующих реплик совпадает с указанным. Для Job параметр параллелизма обновляется только в том случае, если его текущее значение совпадает с указанным.
host string	URL для доступа к API. Также можно задать с помощью переменной окружения K8S_AUTH_HOST.
impersonate_groups list / элементы=string добавлено в kubernetes.core 2.3.0	Группа или группы, от имени которых выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user string добавлено в kubernetes.core 2.3.0	Имя пользователя, от имени которого выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER.
kind string	Указывает модель объекта. Используется для создания, удаления или обнаружения объекта без предоставления полного описания ресурса. Используется совместно с api_version, name и namespace для идентификации конкретного объекта. Если указано описание ресурса, значение kind из resource_definition переопределит этот параметр.
kubeconfig any	Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и другие параметры подключения также не заданы, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, используя разделитель «;» в Windows и «:» на других платформах. Конфигурацию Kubernetes можно указать в виде словаря. Для этой функции требуется версия клиента python kubernetes >= 17.17.0. Добавлено в версии 2.2.0.
label_selectors list / элементы=string добавлено в kubernetes.core 2.0.0	Список селекторов меток для фильтрации результатов. По умолчанию: `[]`
name string	Указывает имя объекта. Используется для создания, удаления или обнаружения объекта без предоставления полного описания ресурса. Используется совместно с api_version, kind и namespace для идентификации конкретного объекта. Если указано описание ресурса, значение metadata.name из resource_definition переопределит этот параметр.
namespace string	Указывает пространство имён объекта. Полезно при создании, удалении или обнаружении объекта без предоставления полного описания ресурса. Используется совместно с api_version, kind и name для идентификации конкретного объекта. Если указано описание ресурса, значение metadata.namespace из resource_definition переопределит этот параметр.
no_proxy string добавлено в kubernetes.core 2.3.0	Список хостов, доменов, IP-адресов или CIDR-сетей, разделённых запятыми, для которых не следует использовать прокси. Также можно задать с помощью переменной окружения K8S_AUTH_NO_PROXY. Обратите внимание, что этот модуль не использует стандартные параметры прокси из окружения (например, NO_PROXY). Для этой функции требуется kubernetes>=19.15.0. При версии библиотеки kubernetes ниже 19.15.0 модуль завершится с ошибкой, даже если no_proxy задан правильно. Пример значения: “localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16”
password string	Пароль для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_PASSWORD. Описание параметра `username` содержит сведения о случаях, в которых применим этот параметр.
persist_config boolean	Сохранять ли токены обновления kube config. Также можно задать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG. Если в контексте k8s используются учётные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой клиента k8s для Python, но по умолчанию не сохраняется. В результате срок действия старого токена обновления может истечь, и следующая попытка аутентификации завершится ошибкой. Если установить этот флаг в true, клиент k8s для Python сохранит новый токен обновления в файл kube config. По умолчанию — false. Обратите внимание: текущая версия библиотеки клиента k8s для Python пока не поддерживает установку этого флага в True. Исправление для этой библиотеки k8s находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
proxy string	URL HTTP-прокси для подключения. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует стандартные параметры прокси из окружения (например, HTTP_PROXY).
proxy_headers dictionary добавлено в kubernetes.core 2.0.0	Заголовок, используемый для HTTP-прокси. Документацию см. здесь: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
basic_auth string	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth string	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации прокси. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent string	Строка, задающая user-agent, например foo/1.0. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
replicas integer / обязательный	Требуемое число реплик.
resource_definition псевдонимы: definition, inline string	Корректное описание объекта в формате YAML (в виде строки, списка или словаря) для создания или обновления. ПРИМЕЧАНИЕ: значения kind, api_version, name и namespace будут переопределены соответствующими значениями из указанного resource_definition.
resource_version string	Масштабирование выполняется только в том случае, если текущая версия объекта совпадает с указанной.
src path	Путь к файлу с корректным описанием объекта или объектов в формате YAML для создания или обновления. Несовместим с resource_definition. ПРИМЕЧАНИЕ: значения kind, api_version, name и namespace будут переопределены соответствующими значениями из конфигурации, прочитанной из файла src. Файл считывается из локальной файловой системы. Чтобы прочитать файл из файловой системы контроллера Ansible, в том числе файл с хранилищем, используйте модуль подстановки file или template вместе с фильтром from_yaml и передайте результат в resource_definition. См. примеры ниже. URL файлов манифестов, которые можно использовать для создания ресурса. Добавлено в версии 2.4.0. Несовместим с template в модуле kubernetes.core.k8s.
username string	Имя пользователя для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_USERNAME. Обратите внимание: этот параметр работает только с кластерами, настроенными для использования HTTP Basic Auth. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом. В таком случае обратитесь к модулю community.okd.k8s_auth — возможно, он подойдёт для ваших задач.
validate_certs псевдонимы: verify_ssl boolean	Проверять ли SSL-сертификаты API-сервера. Также можно задать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`
wait boolean	Для Deployment, ReplicaSet и Replication Controller — ожидать, пока значение ready_replicas в статусе не станет равным числу replicas. Для Job этот параметр игнорируется. Варианты: `false` `true` ← (по умолчанию)
wait_sleep integer добавлено в kubernetes.core 2.0.0	Количество секунд ожидания между проверками. По умолчанию: `5`
wait_timeout integer	Если `wait` имеет значение True, количество секунд ожидания, пока статус ready_replicas не станет равным replicas. Если за отведённое время нужный статус не будет достигнут, произойдёт ошибка. Для Job этот параметр игнорируется. По умолчанию: `20`

Примечания

Примечание

Чтобы избежать ошибок проверки SSL-сертификата, когда validate_certs имеет значение True, необходимо предоставить полную цепочку сертификатов API-сервера с помощью ca_cert или в файле kubeconfig.

Примеры

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

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

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

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

- name: Scale deployment using label selectors (continue operation in case error occured on one resource)
  kubernetes.core.k8s_scale:
    replicas: 3
    kind: Deployment
    namespace: test
    label_selectors:
      - app=test
    continue_on_error: true

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

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

Ключ	Описание
result complex	Если были внесены изменения, возвращает изменённый объект; в противном случае возвращает существующий объект. Возвращается: при успешном выполнении
api_version string	Версия схемы представления этого объекта. Возвращается: при успешном выполнении
duration integer	время выполнения задачи в секундах Возвращается: когда `wait` имеет значение true Пример: `48`
kind string	Тип ресурса REST, представленного этим объектом. Возвращается: при успешном выполнении
metadata complex	Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д. Возвращается: при успешном выполнении
spec complex	Определённые атрибуты объекта. Зависит от значений api_version и kind. Возвращается: при успешном выполнении
status complex	Сведения о текущем статусе объекта. Возвращается: при успешном выполнении

Авторы

Chris Houseknecht (@chouseknecht)
Fabian von Feilitzsch (@fabianvf)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubernetes/core/k8s_scale_module.html