Spec-Zone.ru › Ansible

Модуль community.aws.lightsail – Управление экземплярами в AWS Lightsail

Примечание

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

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

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

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

Новое в community.aws 1.0.0

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

Обзор

  • Управление экземплярами в AWS Lightsail.
  • Тегирование экземпляров пока не поддерживается в этом модуле.

Требования

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

  • 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

строка

ID ключа доступа 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 Bundle для проверки сертификатов SSL.

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

aws_config

словарь

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

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

blueprint_id

строка

ID шаблона образа экземпляра.

Требуется, когда state=present

bundle_id

строка

Набор данных спецификации для экземпляра.

Требуется, когда state=present.

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.

key_pair_name

строка

Имя пары ключей для использования с экземпляром.

Если state=present и key_pair_name не указан, будет использоваться пара ключей по умолчанию из региона.

name

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

Имя экземпляра.

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.

public_ports

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

добавлено в community.aws 6.0.0

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

cidrs

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

IP-адрес IPv4 или диапазон IPv4-адресов (в формате CIDR), которые разрешено подключаться к экземпляру через порты и протокол.

Один из cidrs или ipv6_cidrs должен быть указан.

from_port

целое число / обязательный

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

ipv6_cidrs

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

IP-адрес IPv6 или диапазон IPv6-адресов (в формате CIDR), которые разрешено подключаться к экземпляру через порты и протокол.

Один из cidrs или ipv6_cidrs должен быть указан.

protocol

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

Имя IP-протокола, принимаемого для определенного диапазона открытых портов.

Варианты:

  • "tcp"
  • "all"
  • "udp"
  • "icmp"

to_port

целое число / обязательный

Последний порт в диапазоне открытых портов на экземпляре.
END_OF_DOCUMENT_MARKER

region

aliases: aws_region, ec2_region

string

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 botocore AWS.

Псевдоним 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

Указывает желаемое состояние целевого объекта.

rebooted и restarted являются псевдонимами.

Варианты:

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

user_data

string

Скрипт запуска, который может настроить экземпляр с дополнительными данными.

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

validate_certs

boolean

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

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

Варианты:

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

wait

boolean

Ожидать, пока экземпляр перейдет в состояние «запущен» перед возвратом.

Если wait=false, адрес ip может не быть возвращен.

Не имеет эффекта при state=rebooted или state=absent.

Варианты:

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

wait_timeout

integer

Сколько времени ожидать, прежде чем wait прекратится, в секундах.

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

zone

string

AWS зона доступности для запуска экземпляра.

Требуется при state=present

Примечания

Примечание

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

Примеры

- name: Create a new Lightsail instance
  community.aws.lightsail:
    state: present
    name: my_instance
    region: us-east-1
    zone: us-east-1a
    blueprint_id: ubuntu_16_04
    bundle_id: nano_1_0
    key_pair_name: id_rsa
    user_data: " echo 'hello world' > /home/ubuntu/test.txt"
    public_ports:
      - from_port: 22
        to_port: 22
        protocol: "tcp"
        cidrs: ["0.0.0.0/0"]
        ipv6_cidrs: ["::/0"]
  register: my_instance

- name: Delete an instance
  community.aws.lightsail:
    state: absent
    region: us-east-1
    name: my_instance

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

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

Ключ

Описание

changed

boolean

если снимок был изменён/создан

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

Пример: {"changed": true}

instance

словарь

данные инстанса

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

Пример: {"arn": "arn:aws:lightsail:us-east-1:123456789012:Instance/1fef0175-d6c8-480e-84fa-214f969cda87", "blueprint_id": "ubuntu_16_04", "blueprint_name": "Ubuntu", "bundle_id": "nano_1_0", "created_at": "2017-03-27T08:38:59.714000-04:00", "hardware": {"cpu_count": 1, "ram_size_in_gb": 0.5}, "is_static_ip": false, "location": {"availability_zone": "us-east-1a", "region_name": "us-east-1"}, "name": "my_instance", "networking": {"monthly_transfer": {"gb_per_month_allocated": 1024}, "ports": [{"access_direction": "inbound", "access_from": "Anywhere (0.0.0.0/0)", "access_type": "public", "common_name": "", "from_port": 80, "protocol": "tcp", "to_port": 80}, {"access_direction": "inbound", "access_from": "Anywhere (0.0.0.0/0)", "access_type": "public", "common_name": "", "from_port": 22, "protocol": "tcp", "to_port": 22}]}, "private_ip_address": "172.26.8.14", "public_ip_address": "34.207.152.202", "resource_type": "Instance", "ssh_key_name": "keypair", "state": {"code": 16, "name": "running"}, "support_code": "123456789012/i-0997c97831ee21e33", "username": "ubuntu"}

Авторы

  • Nick Ball (@nickball)
  • Prasad Katti (@prasadkatti)

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

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

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

Spec-Zone.ru

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