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 bool (добавлено в 2.5)	Варианты: нет ← да	Булево значение, если истинно, создаёт зашифрованную файловую систему. Не может быть изменено после создания файловой системы.
id		Идентификатор Amazon EFS. Требуется либо имя, либо идентификатор для удаления.
kms_key_id (добавлено в 2.5)		Идентификатор AWS KMS CMK, который будет использоваться для защиты зашифрованной файловой системы. Этот параметр требуется только если вы хотите использовать нестандартный CMK. Если этот параметр не указан, используется стандартный CMK для Amazon EFS. Идентификатор ключа может быть ID ключа, ARN ID ключа, псевдонимом ключа или ARN псевдонима ключа.
name		Токен создания файловой системы Amazon EFS. Требуется для создания и обновления. Требуется либо имя, либо идентификатор для удаления.
performance_mode	Варианты: general_purpose ← max_io	Режим производительности файловой системы. Действует только при создании.
profile (добавлено в 1.6)		Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags bool (добавлено в 2.5)	Варианты: нет да ←	Если да, существующие теги будут удалены с ресурса, чтобы точно соответствовать тем, что определены параметром tags. Если параметр tags не задан, теги не будут изменены.
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' со списком тегов и существующей EFS (сопоставленной по имени), теги EFS будут заменены предоставленными данными.
targets		Список подключенных целей. Он должен быть списком словарей, каждый словарь должен содержать следующие атрибуты: - subnet_id - Обязательный. ID подсети для добавления целевого подключения. - ip_address - Необязательный. Действительный IPv4 адрес в диапазоне адресов указанной подсети. - security_groups - Необязательный. Список идентификаторов групп безопасности, вида 'sg-xxxxxxxx'. Они должны относиться к той же VPC, что и указанная подсеть. Эти данные могут быть изменены для существующей EFS с состоянием 'present' и новым списком целевых подключений.
validate_certs bool (добавлено в 1.5)	Варианты: нет да ←	При установке в «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.
wait bool	Варианты: нет ← да	В случае состояния '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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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
life_cycle_state строка	всегда	состояние файловой системы EFS Пример: creating, available, deleting, deleted
mount_point строка	всегда	URL файловой системы Пример: .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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых партнерами 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.6/modules/efs_module.html