Spec-Zone.ru › Ansible

Модуль amazon.aws.autoscaling_instance_refresh – запуск или отмена обновления экземпляров группы автоматического масштабирования EC2 (ASG) в AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.autoscaling_instance_refresh.

Добавлено в community.aws 3.2.0

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

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

  • Запускает или отменяет обновление экземпляров группы автоматического масштабирования EC2 в AWS.
  • Можно использовать вместе с amazon.aws.autoscaling_instance_refresh_info, чтобы отслеживать ход выполнения.
  • До выпуска версии 5.0.0 модуль назывался community.aws.ec2_asg_instance_refresh. Использование не изменилось.

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

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

string

Идентификатор ключа доступа 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 (в порядке убывания приоритета).

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

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.

aws_ca_bundle

path

Путь к набору сертификатов центра сертификации для проверки SSL-сертификатов.

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

aws_config

dictionary

Словарь для изменения конфигурации botocore.

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

псевдоним: aws_endpoint_url

string

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

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

name

псевдоним: group_name

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

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

preferences

dictionary

Набор параметров обновления экземпляров.

Если параметры не указаны, используются значения по умолчанию.

Для preferences.min_healthy_percentage значение по умолчанию — 90.

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

Нельзя указывать, если задано state=cancelled.

instance_warmup

integer

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

В течение этого времени Amazon EC2 Auto Scaling не переходит сразу к замене следующего экземпляра.

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

max_healthy_percentage

integer

добавлено в amazon.aws 9.0.0

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

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

Допустимый диапазон значений: от 100 до 200.

Если этот параметр указан, необходимо также указать preferences.min_healthy_percentage, а разница между ними не должна превышать 100.

min_healthy_percentage

integer

Общий процент емкости ASG, который должен оставаться работоспособным во время обновления экземпляров, чтобы операция могла продолжаться.

Значение округляется вверх до ближайшего целого числа.

Допустимый диапазон значений: от 0 до 100.

По умолчанию: 90

skip_matching

boolean

добавлено в amazon.aws 9.0.0

Указывает, включен ли пропуск совпадающих экземпляров.

Если включено true, Amazon EC2 Auto Scaling пропускает замену экземпляров, соответствующих желаемой конфигурации.

Варианты:

  • false
  • true

profile

псевдоним: aws_profile

string

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

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

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

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.

region

псевдоним: aws_region

string

Регион AWS.

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

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

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

secret_key

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

string

Секретный ключ доступа 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 (в порядке убывания приоритета).

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

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

session_token

псевдоним: aws_session_token

string

Токен сеанса 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.

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

state

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

Требуемое состояние ASG.

Варианты:

  • "started"
  • "cancelled"

strategy

string

Стратегия обновления экземпляров. Единственное допустимое значение — Rolling.

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

Поэтапное обновление может завершиться с ошибкой из-за неудачной проверки работоспособности либо если экземпляры находятся в режиме ожидания или защищены от уменьшения масштаба.

Если процесс поэтапного обновления завершится с ошибкой, уже замененные экземпляры не будут восстановлены до предыдущей конфигурации.

По умолчанию: "Rolling"

validate_certs

boolean

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

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рекомендуется указать aws_ca_bundle.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» 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.

- name: Start a refresh
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: started

- name: Cancel a refresh
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: cancelled

- name: Start a refresh and pass preferences
  amazon.aws.autoscaling_instance_refresh:
    name: some-asg
    state: started
    preferences:
      min_healthy_percentage: 91
      instance_warmup: 60
      skip_matching: true

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

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

Ключ

Описание

instance_refreshes

complex

Сведения об обновлениях экземпляров группы автоматического масштабирования.

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

auto_scaling_group_name

string

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

Возвращается: при успешном выполнении

Пример: "public-webapp-production-1"

end_time

string

Дата и время создания этой ASG в формате ISO 8601.

Возвращается: при успешном выполнении

Пример: "2015-11-25T00:05:36.309Z"

instance_refresh_id

string

Идентификатор обновления экземпляров.

Возвращается: при успешном выполнении

Пример: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"

instances_to_update

integer

Количество экземпляров для обновления.

Возвращается: при успешном выполнении

Пример: 5

percentage_complete

integer

Процент выполнения.

Возвращается: при успешном выполнении

Пример: 100

preferences

dictionary

Параметры обновления экземпляров.

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

Пример: {"AlarmSpecification": {"Alarms": ["my-alarm"]}, "AutoRollback": true, "InstanceWarmup": 200, "MinHealthyPercentage": 90, "ScaleInProtectedInstances": "Ignore", "SkipMatching": false, "StandbyInstances": "Ignore"}

start_time

string

Дата и время создания этой ASG в формате ISO 8601.

Возвращается: при успешном выполнении

Пример: "2015-11-25T00:05:36.309Z"

status

string

Текущее состояние группы во время выполнения DeleteAutoScalingGroup.

Возможны следующие состояния:

Pending — запрос создан, но операция еще не началась.

InProgress — операция выполняется.

Successful — операция успешно завершена.

Failed — не удалось завершить операцию. Для устранения неполадок можно использовать причину состояния и сведения о действиях по масштабированию.

Cancelling — выполняется отмена операции. Отмена не восстанавливает экземпляры, замена которых уже завершена, но предотвращает начало новых замен.

Cancelled — операция отменена.

Возвращается: при успешном выполнении

Пример: "Pending"

Авторы

  • Dan Khersonsky (@danquixote)

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

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

© 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/amazon/aws/autoscaling_instance_refresh_module.html

Spec-Zone.ru

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