Spec-Zone.ru › Ansible

community.aws.application_autoscaling_policy модуль — Управление политиками масштабирования Application Auto Scaling

Примечание

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

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

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

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

Новый в community.aws 1.0.0

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

Обзор

  • Создаёт, обновляет или удаляет политику масштабирования.
  • До версии 5.0.0 этот модуль назывался community.aws.aws_application_scaling_policy. Способ использования не изменился.

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

Требования

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

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

Параметры

Параметр

Комментарии

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.

aws_ca_bundle

путь

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

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

aws_config

словарь

Словарь для изменения настроек botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Используйте логгер botocore.endpoint для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов, чтобы вывести общий список, созданный во время выполнения книги задач.

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

Варианты:

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

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

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

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

maximum_tasks

целое число

Максимальное значение масштабирования в ответ на событие увеличения масштаба. Этот параметр необходим, если вы создаете первую новую политику для указанной службы.

minimum_tasks

целое число

Минимальное значение масштабирования в ответ на событие уменьшения масштаба. Этот параметр необходим, если вы создаете первую новую политику для указанной службы.

override_task_capacity

булево

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

По умолчанию false.

Варианты:

  • false
  • true

policy_name

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

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

policy_type

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

Тип политики.

Варианты:

  • "StepScaling"
  • "TargetTrackingScaling"

profile

псевдонимы: aws_profile

строка

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

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

Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token.

region

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

строка

Используемый регион AWS.

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

Также можно использовать переменные среды 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.

resource_id

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

Идентификатор ресурса, связанного с целевым объектом масштабирования.

scalable_dimension

string / обязательно

Изменяемая размерность, связанная с целевым масштабируемым ресурсом.

Варианты:

  • "ecs:service:DesiredCount"
  • "ec2:spot-fleet-request:TargetCapacity"
  • "elasticmapreduce:instancegroup:InstanceCount"
  • "appstream:fleet:DesiredCapacity"
  • "dynamodb:table:ReadCapacityUnits"
  • "dynamodb:table:WriteCapacityUnits"
  • "dynamodb:index:ReadCapacityUnits"
  • "dynamodb:index:WriteCapacityUnits"

secret_key

псевдонимы: 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 в порядке убывания приоритета.

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

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

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

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

service_namespace

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

Пространство имен AWS-службы.

Варианты:

  • "ecs"
  • "elasticmapreduce"
  • "ec2"
  • "appstream"
  • "dynamodb"

session_token

псевдонимы: 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 в порядке убывания приоритета.

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

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

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

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

state

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

Указывает, должен ли параметр present или absent.

Варианты:

  • "absent"
  • "present"

step_scaling_policy_configuration

словарь

Политика ступенчатого масштабирования. Этот параметр обязателен при создании политики и policy_type=StepScaling.

target_tracking_scaling_policy_configuration

словарь

Политика масштабирования по отслеживанию целевых значений. Этот параметр обязателен при создании новой политики и policy_type=TargetTrackingScaling.

Полная документация по подпараметрам доступна в документации API:

https://docs.aws.amazon.com/autoscaling/application/APIReference/API_TargetTrackingScalingPolicyConfiguration.html

CustomizedMetricSpecification

словарь

Метрика для использования при использовании настраиваемой метрики.

DisableScaleIn

логическое

Отключает масштабирование-в.

Варианты:

  • false
  • true

PredefinedMetricSpecification

словарь

Метрика для использования при использовании предопределённой метрики.

ScaleInCooldown

целое число

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

ScaleOutCooldown

целое число

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

TargetValue

вещественное число

Целевое значение метрики.

validate_certs

логическое

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

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

Варианты:

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

Примечания

Примечание

  • Дополнительные сведения о параметрах и возвращаемых значениях см. в http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy
  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Следовательно, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Create step scaling policy for ECS Service
- name: scaling_policy
  community.aws.application_autoscaling_policy:
    state: present
    policy_name: test_policy
    service_namespace: ecs
    resource_id: service/poc-pricing/test-as
    scalable_dimension: ecs:service:DesiredCount
    policy_type: StepScaling
    minimum_tasks: 1
    maximum_tasks: 6
    step_scaling_policy_configuration:
      AdjustmentType: ChangeInCapacity
      StepAdjustments:
        - MetricIntervalUpperBound: 123
          ScalingAdjustment: 2
        - MetricIntervalLowerBound: 123
          ScalingAdjustment: -2
      Cooldown: 123
      MetricAggregationType: Average

# Create target tracking scaling policy for ECS Service
- name: scaling_policy
  community.aws.application_autoscaling_policy:
    state: present
    policy_name: test_policy
    service_namespace: ecs
    resource_id: service/poc-pricing/test-as
    scalable_dimension: ecs:service:DesiredCount
    policy_type: TargetTrackingScaling
    minimum_tasks: 1
    maximum_tasks: 6
    target_tracking_scaling_policy_configuration:
      TargetValue: 60
      PredefinedMetricSpecification:
        PredefinedMetricType: ECSServiceAverageCPUUtilization
      ScaleOutCooldown: 60
      ScaleInCooldown: 60

# Remove scalable target for ECS Service
- name: scaling_policy
  community.aws.application_autoscaling_policy:
    state: absent
    policy_name: test_policy
    policy_type: StepScaling
    service_namespace: ecs
    resource_id: service/cluster-name/service-name
    scalable_dimension: ecs:service:DesiredCount

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

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

Ключ

Описание

alarms

сложный

Список CloudWatch-тревог, связанных с политикой масштабирования

Возвращается: при состоянии present

alarm_arn

строка

Идентификатор Amazon Resource Name (ARN) тревоги

Возвращается: при состоянии present

alarm_name

строка

Имя тревоги

Возвращается: при состоянии present

creation_time

строка

Отметка времени Unix, когда был создан масштабируемый целевой объект.

Возвращается: при состоянии present

Пример: "2017-09-28T08:22:51.881000-03:00"

max_capacity

целое число

Максимальное значение масштабирования в ответ на событие увеличения масштаба. Требуется, если состояние present.

Возвращается: при состоянии present

Пример: 2

min_capacity

целое число

Минимальное значение масштабирования в ответ на событие уменьшения масштаба. Требуется, если состояние present.

Возвращается: при состоянии present

Пример: 1

policy_arn

строка

Идентификатор Amazon Resource Name (ARN) политики масштабирования.

Возвращается: при состоянии present

policy_name

строка

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

Возвращается: при состоянии present

policy_type

строка

Тип политики.

Возвращается: при состоянии present

resource_id

строка

Идентификатор ресурса, связанного с масштабируемым целевым объектом.

Возвращается: при состоянии present

Пример: "service/cluster-name/service-name"

role_arn

строка

ARN роли IAM, которая позволяет Application Auto Scaling изменять масштабируемый целевой объект от вашего имени. Требуется, если состояние present.

Возвращается: при состоянии present

Пример: "arn:aws:iam::123456789012:role/roleName"

scalable_dimension

строка

Масштабируемое измерение, связанное со масштабируемым целевым объектом.

Возвращается: при состоянии present

Пример: "ecs:service:DesiredCount"

service_namespace

строка

Пространство имен AWS-службы.

Возвращается: при состоянии present

Пример: "ecs"

step_scaling_policy_configuration

сложный

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

Возвращается: при состоянии present и типе политики StepScaling

adjustment_type

строка

Тип корректировки

Возвращается: при состоянии present и типе политики StepScaling

Пример: "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity"

cooldown

целое число

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

Возвращается: при состоянии present и типе политики StepScaling

Пример: 60

metric_aggregation_type

строка

Тип агрегирования для метрик CloudWatch

Возвращается: при состоянии present и типе политики StepScaling

Пример: "Average, Minimum, Maximum"

step_adjustments

список / элементы=словарь

Набор настроек, позволяющих масштабировать в соответствии с объёмом превышения порогового значения тревоги

Возвращается: при состоянии present и типе политики StepScaling

target_tracking_scaling_policy_configuration

сложный

Политика отслеживания целевого значения.

Возвращается: при состоянии present и типе политики TargetTrackingScaling

predefined_metric_specification

сложный

Предопределённый метрический показатель

Возвращается: при состоянии present и типе политики TargetTrackingScaling

predefined_metric_type

строка

Тип метрики

Возвращается: при состоянии present и типе политики TargetTrackingScaling

Пример: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization"

resource_label

строка

Идентифицирует ресурс, связанный с типом метрики

Возвращается: при типе метрики ALBRequestCountPerTarget

scale_in_cooldown

целое число

Время в секундах после завершения уменьшения масштаба до начала следующей операции уменьшения

Возвращается: при состоянии present и типе политики TargetTrackingScaling

Пример: 60

scale_out_cooldown

целое число

Время в секундах после завершения увеличения масштаба до начала следующей операции увеличения

Возвращается: при состоянии present и типе политики TargetTrackingScaling

Пример: 60

target_value

целое число

Целевое значение метрики

Возвращается: при состоянии present и типе политики TargetTrackingScaling

Пример: 70

Авторы

  • Gustavo Maia (@gurumaia)
  • Chen Leibovich (@chenl87)

Ссылки на сборку

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

© 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/application_autoscaling_policy_module.html

Spec-Zone.ru

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