Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.aws.autoscaling_instance_refresh.

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

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

Обзор

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

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

Требования

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

  • 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.

name

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

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

preferences

словарь

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

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

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

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

Не может быть указано, когда state установлено в ‘cancelled’.

instance_warmup

целое число

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

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

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

min_healthy_percentage

целое число

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

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

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

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.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

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

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

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

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

session_token

aliases: aws_session_token, security_token, aws_security_token, access_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, 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

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, а не из контекста хоста.
  • 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.

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

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

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

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

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

Ключ

Описание

auto_scaling_group_name

строка

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

Возвращаемое значение: успех

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

end_time

строка

Дата и время создания этой группы автомасштабирования в формате ISO 8601.

Возвращаемое значение: успех

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

instance_refresh_id

строка

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

Возвращаемое значение: успех

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

instances_to_update

целое число

кол-во экземпляров для обновления

Возвращаемое значение: успех

Пример: 5

percentage_complete

целое число

% завершённости

Возвращаемое значение: успех

Пример: 100

start_time

строка

Дата и время создания этой группы автомасштабирования в формате ISO 8601.

Возвращаемое значение: успех

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

status

строка

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

Возможные состояния:

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

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

Успешно — операция выполнена успешно.

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

Отменяется —

В процессе отмены текущей операции.

Отмена не отменяет уже выполненные замены,

но предотвращает начало новых замен.

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

Возвращаемое значение: успех

Пример: "Pending"

Авторы

  • Dan Khersonsky (@danquixote)

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

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

© 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_instance_refresh_module.html

Spec-Zone.ru

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