efs – создание и поддержание файловых систем EFS

Новая версия с 2.2.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Модуль позволяет создавать, искать и удалять файловые системы Amazon EFS

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key -		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key -		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url -		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
encrypt boolean добавлен в 2.5	Варианты: нет ← да	Булево значение, которое, если истинно, создаёт зашифрованную файловую систему. Это значение нельзя изменить после создания файловой системы.
id -		ID файловой системы Amazon EFS. Для удаления требуется либо имя, либо ID.
kms_key_id - добавлен в 2.5		Идентификатор AWS KMS CMK, который будет использоваться для защиты зашифрованной файловой системы. Этот параметр требуется только в случае использования нестандартного CMK. Если этот параметр не указан, используется стандартный CMK для Amazon EFS. Идентификатор ключа может быть идентификатором ключа, ARN ключа, псевдонимом ключа или ARN псевдонима ключа.
name -		Токен создания файловой системы Amazon EFS. Требуется для создания и обновления. Для удаления требуется либо имя, либо ID.
performance_mode -	Варианты: general_purpose ← max_io	Режим производительности файловой системы. Действует только при создании.
profile - добавлен в 1.6		Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags boolean добавлен в 2.5	Варианты: нет да ←	Если да, существующие теги будут удалены из ресурса для точного соответствия параметру теги. Если параметр теги не задан, теги не будут изменены.
region -		Регион AWS. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token - добавлен в 1.6		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state -	Варианты: present ← absent	Позволяет создавать, искать и удалять файловую систему Amazon EFS
tags -		Список тегов Amazon EFS. Должен быть определён как словарь. В случае состояния 'present' со списком тегов и существующей файловой системой (сопоставление по 'name'), теги файловой системы будут заменены предоставленными данными.
targets -		Список подключенных целей. Он должен быть списком словарей, каждый словарь должен включать следующие атрибуты: - subnet_id - Обязательно. Идентификатор подсети для добавления целевого подключения. - ip_address - Необязательно. Действительный IPv4-адрес в диапазоне адресов указанной подсети. - security_groups - Необязательно. Список идентификаторов групп безопасности в формате 'sg-xxxxxxxx'. Они должны относиться к той же VPC, что и указанная подсеть. Эти данные могут быть изменены для существующей файловой системы с помощью состояния 'present' и нового списка целевых подключений.
validate_certs boolean добавлен в 1.5	Варианты: нет да ←	Если установлено «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.
wait boolean	Варианты: нет ← да	В случае состояния 'present' следует ожидать состояния жизненного цикла EFS 'available' (конечно, если текущее состояние не 'deleting' или 'deleted'). В случае состояния 'absent' следует ожидать состояния жизненного цикла EFS 'deleted'.
wait_timeout -	По умолчанию: 0	Время ожидания модулем (в секундах) желаемого состояния перед возвратом. Ноль означает ожидание до достижения желаемого состояния.

Примечания

Примечание

Если параметры не заданы внутри модуля, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION могут использоваться для указания региона AWS, когда это необходимо, но это также может быть настроено в файле конфигурации boto

Примеры

# EFS provisioning
- efs:
    state: present
    name: myTestEFS
    tags:
        name: myTestNameTag
        purpose: file-storage
    targets:
        - subnet_id: subnet-748c5d03
          security_groups: [ "sg-1a2b3c4d" ]

# Modifying EFS data
- efs:
    state: present
    name: myTestEFS
    tags:
        name: myAnotherTestTag
    targets:
        - subnet_id: subnet-7654fdca
          security_groups: [ "sg-4c5d6f7a" ]

# Deleting EFS
- efs:
    state: absent
    name: myTestEFS

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

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

Ключ	Возвращаемое значение	Описание
creation_time строка	всегда	временная метка даты создания Пример: 2015-11-16 07:30:57-05:00
creation_token строка	всегда	токен создания EFS Пример: console-88609e04-9a0e-4a2e-912c-feaa99509961
file_system_id строка	всегда	Идентификатор файловой системы Пример: fs-xxxxxxxx
filesystem_address строка	всегда	URL файловой системы, пригодный для использования с монтированием Пример: fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
life_cycle_state строка	всегда	состояние файловой системы EFS Пример: creating, available, deleting, deleted
mount_point строка	всегда	URL файловой системы с ведущей точкой, начиная с момента, когда AWS EFS потребовалось добавить суффикс региона к адресу Пример: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
mount_targets список	всегда	список целевых точек монтирования Пример: [{'file_system_id': 'fs-a7ad440e', 'ip_address': '172.31.17.173', 'life_cycle_state': 'available', 'mount_target_id': 'fsmt-d8907871', 'network_interface_id': 'eni-6e387e26', 'owner_id': '740748460359', 'security_groups': ['sg-a30b22c6'], 'subnet_id': 'subnet-e265c895'}, '...']
name строка	всегда	имя файловой системы Пример: my-efs
number_of_mount_targets целое число	всегда	количество смонтированных целей Пример: 3
owner_id строка	всегда	Идентификатор учетной записи AWS владельца EFS Пример: XXXXXXXXXXXX
performance_mode строка	всегда	режим производительности файловой системы Пример: generalPurpose
size_in_bytes словарь	всегда	размер файловой системы в байтах по состоянию на отметку времени Пример: {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
tags словарь	всегда	метки на экземпляре efs Пример: {'name': 'my-efs', 'key': 'Value'}

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

Ryan Sydnor (@ryansydnor)
Artem Kazakov (@akazakov)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/efs_module.html