Spec-Zone.ru › Ansible

community.aws.autoscaling_policy модуль — Создание или удаление политик масштабирования AWS для групп Autoscaling

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

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

Для её установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в плейбуке, укажите: community.aws.autoscaling_policy.

Новая функция в community.aws 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Может создавать или удалять политики масштабирования для групп autoscaling.
  • Ссылающиеся на группы autoscaling должны уже существовать.
  • До версии 5.0.0 этот модуль назывался community.aws.ec2_scaling_policy. Использование не изменилось.

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

adjustment_type

строка

Тип изменения емкости группы автомасштабирования.

Требуется, если state равно present.

Варианты:

  • "ChangeInCapacity"
  • "ExactCapacity"
  • "PercentChangeInCapacity"

asg_name

строка

Имя связанной группы автомасштабирования.

Требуется, если state равно present.

aws_ca_bundle

путь

Расположение файла CA-сертификатов для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.
END_OF_DOCUMENT_MARKER

регион

псевдонимы: aws_region, ec2_region

строка

AWS регион для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, регион игнорируется.

Также могут быть использованы переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS по адресу http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в выпуске после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в выпуске после 2024-12-01.

изменение_масштаба

целое число

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

Отрицательное число уменьшает ASG.

Единицы — количество экземпляров для ExactCapacity или ChangeInCapacity или процент существующих экземпляров для PercentChangeInCapacity.

Требуется, когда policy_type — SimpleScaling.

ключ_секрета

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY также могут быть использованы в порядке убывания приоритета.

Параметры ключ_секрета и профиль взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в выпуске после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в выпуске после 2024-12-01.

токен_сессии

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

AWS STS токен сессии для использования с временными учетными данными.

Дополнительную информацию о маркерах доступа см. в документации AWS по адресу https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN также могут быть использованы в порядке убывания приоритета.

Параметры токен_сессии и профиль взаимоисключающие.

Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в выпуске после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в выпуске после 2024-12-01.

состояние

строка

Зарегистрировать или удалить политику.

Варианты:

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

statistic

строка / обязательно

Статистика метрики.

Варианты:

  • "Average"
  • "Minimum"
  • "Maximum"
  • "SampleCount"
  • "Sum"

unit

строка

Единица измерения метрики. Обратитесь к API AmazonCloudWatch для получения списка допустимых единиц.

disable_scalein

булево

Указывает, отключено ли масштабирование вниз целевой политики.

Варианты:

  • false
  • true

predefined_metric_spec

словарь

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

predefined_metric_type

строка / обязательно

Обязательно, если используется predefined_metric_spec.

Варианты:

  • "ASGAverageCPUUtilization"
  • "ASGAverageNetworkIn"
  • "ASGAverageNetworkOut"
  • "ALBRequestCountPerTarget"

resource_label

строка

Уникально идентифицирует конкретную целевую группу ALB, по которой определяется среднее количество обращений, обслуживаемых группой автоматического масштабирования.

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

target_value

вещественное / обязательно

Укажите вещественное число для целевого использования.

Требуется при указании target_tracking_config.

validate_certs

булево

Если установлено в false, сертификаты SSL не будут проверены для связи с API AWS.

Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы рассмотрите настройку aws_ca_bundle.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста хоста Ansible, а не из контекста контроллера. В связи с этим файлы, возможно, нужно будет явно скопировать на хост. Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста контроллера Ansible, а не из контекста хоста.
  • AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из его конфигурационных файлов в контексте хоста Ansible (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

- name: Simple Scale Down policy
  community.aws.autoscaling_policy:
    state: present
    region: US-XXX
    name: "scaledown-policy"
    adjustment_type: "ChangeInCapacity"
    asg_name: "application-asg"
    scaling_adjustment: -1
    min_adjustment_step: 1
    cooldown: 300

# For an alarm with a breach threshold of 20, the
# following creates a stepped policy:
# From 20-40 (0-20 above threshold), increase by 50% of existing capacity
# From 41-infinity, increase by 100% of existing capacity
- community.aws.autoscaling_policy:
    state: present
    region: US-XXX
    name: "step-scale-up-policy"
    policy_type: StepScaling
    metric_aggregation: Maximum
    step_adjustments:
      - upper_bound: 20
        scaling_adjustment: 50
      - lower_bound: 20
        scaling_adjustment: 100
    adjustment_type: "PercentChangeInCapacity"
    asg_name: "application-asg"

- name: create TargetTracking predefined policy
  community.aws.autoscaling_policy:
    name: "predefined-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      predefined_metric_spec:
        predefined_metric_type: ASGAverageCPUUtilization
      target_value: 98.0
    asg_name: "asg-test-1"
  register: result

- name: create TargetTracking predefined policy with resource_label
  community.aws.autoscaling_policy:
    name: "predefined-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      predefined_metric_spec:
        predefined_metric_type: ALBRequestCountPerTarget
        resource_label: app/my-alb/778d41231d141a0f/targetgroup/my-alb-target-group/942f017f100becff
      target_value: 98.0
    asg_name: "asg-test-1"
  register: result

- name: create TargetTrackingScaling custom policy
  community.aws.autoscaling_policy:
    name: "custom-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      customized_metric_spec:
        metric_name: metric_1
        namespace: namespace_1
        statistic: Minimum
        unit: Gigabits
        dimensions: [{'Name': 'dimension1', 'Value': 'value1'}]
      disable_scalein: true
      target_value: 98.0
    asg_name: asg-test-1
  register: result

Значения возврата

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

Ключ

Описание

adjustment_type

строка

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

Возвращается: всегда

Пример: "PercentChangeInCapacity"

alarms

сложное

Сигналы Cloudwatch, связанные с политикой.

Возвращается: всегда

alarm_arn

строка

ARN сигнала Cloudwatch.

Возвращается: всегда

Пример: "arn:aws:cloudwatch:us-east-2:1234567890:alarm:cpu-very-high"

alarm_name

строка

Имя сигнала Cloudwatch.

Возвращается: всегда

Пример: "cpu-very-high"

arn

строка

ARN политики масштабирования. Предоставляется для обратной совместимости, значение такое же, как policy_arn.

Возвращается: всегда

Пример: "arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy"

as_name

строка

Имя группы Auto Scaling. Предоставляется для обратной совместимости, значение такое же, как auto_scaling_group_name.

Возвращается: всегда

Пример: "app-asg"

auto_scaling_group_name

строка

Имя группы Auto Scaling.

Возвращается: всегда

Пример: "app-asg"

metric_aggregation_type

строка

Метод агрегирования метрик.

Возвращается: когда policy_type равен StepScaling

Пример: "Maximum"

name

строка

Имя политики масштабирования. Предоставляется для обратной совместимости, значение такое же, как policy_name.

Возвращается: всегда

Пример: "app-policy"

policy_arn

строка

ARN политики масштабирования.

Возвращается: всегда

Пример: "arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy"

policy_name

строка

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

Возвращается: всегда

Пример: "app-policy"

policy_type

строка

Тип политики автомасштабирования.

Возвращается: всегда

Пример: "StepScaling"

scaling_adjustment

целое число

Корректировка, выполняемая при срабатывании сигнала.

Возвращается: Когда policy_type равен SimpleScaling

Пример: 1

step_adjustments

сложное

Список пошаговых корректировок.

Возвращается: всегда

metric_interval_lower_bound

число с плавающей точкой

Нижняя граница интервала метрики.

Возвращается: если шаг имеет нижнюю границу

Пример: 20.0

metric_interval_upper_bound

число с плавающей точкой

Верхняя граница интервала метрики.

Возвращается: если шаг имеет верхнюю границу

Пример: 40.0

scaling_adjustment

целое число

Корректировка, выполняемая, если достигнут этот шаг.

Возвращается: всегда

Пример: 50

Авторы

  • Zacharie Eakin (@zeekin)
  • Will Thames (@willthames)

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

  • Отслеживание проблем
  • Репозиторий (источники)
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/autoscaling_policy_module.html

Spec-Zone.ru

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