Модуль 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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение пакета CA для проверки сертификатов SSL. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логический | Использовать Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
name строка / обязательно | Имя группы автоматического масштабирования, которую вы ищете. |
preferences словарь | Набор настроек, связанных с запросом на обновление экземпляров. Если не указано, используются значения по умолчанию. Для min_healthy_percentage значение по умолчанию — Для instance_warmup по умолчанию используется значение, указанное для периода ожидания проверки работоспособности для группы автоматического масштабирования. Не может быть указано, когда state установлено в ‘cancelled’. |
|
instance_warmup целое число |
Количество секунд до того, как запущенный экземпляр будет настроен и готов к использованию. В течение этого времени Amazon EC2 Auto Scaling не переходит к следующей замене. По умолчанию используется значение для периода ожидания проверки работоспособности, определенного для группы. |
|
min_healthy_percentage целое число |
Процент емкости в группе автоматического масштабирования, который должен оставаться работоспособным во время обновления экземпляров, чтобы позволить продолжить работу. Округляется до ближайшего целого числа. По умолчанию: |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Также могут использоваться переменные среды Параметры secret_key и profile взаимоисключающие. Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Алиас 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. Также могут использоваться переменные среды Параметры 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. Поддержка переменных среды |
state string / обязательно | Желаемое состояние ASG. Выбои:
|
strategy string | Используемая стратегия для обновления экземпляров. Единственно допустимое значение — Постепенное обновление — это обновление, которое применяется ко всем экземплярам в группе автоматического масштабирования до тех пор, пока все экземпляры не будут обновлены. Постепенное обновление может завершиться неудачей из-за неудачных проверок работоспособности или если экземпляры находятся в режиме ожидания или защищены от масштабирования. Если процесс постепенного обновления завершается неудачей, любые экземпляры, которые уже были заменены, не возвращаются к исходной конфигурации. По умолчанию: |
validate_certs boolean | При установке в Настройка validate_certs=false категорически не рекомендуется; вместо этого рассмотрите установку aws_ca_bundle. Выбои:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста хоста 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 строка | Имя группы автомасштабирования Возвращаемое значение: успех Пример: |
end_time строка | Дата и время создания этой группы автомасштабирования в формате ISO 8601. Возвращаемое значение: успех Пример: |
instance_refresh_id строка | Идентификатор обновления экземпляров Возвращаемое значение: успех Пример: |
instances_to_update целое число | кол-во экземпляров для обновления Возвращаемое значение: успех Пример: |
percentage_complete целое число | % завершённости Возвращаемое значение: успех Пример: |
start_time строка | Дата и время создания этой группы автомасштабирования в формате ISO 8601. Возвращаемое значение: успех Пример: |
status строка | Текущее состояние группы при выполнении DeleteAutoScalingGroup. Возможные состояния: Ожидание — запрос создан, но операция еще не началась. Выполняется — операция выполняется. Успешно — операция выполнена успешно. Неудача — операция не была выполнена. Для устранения неполадок используйте причину состояния и действия масштабирования. Отменяется — В процессе отмены текущей операции. Отмена не отменяет уже выполненные замены, но предотвращает начало новых замен. Отменено — операция отменена. Возвращаемое значение: успех Пример: |
Ссылки на сборку
© 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