efs - создание и обслуживание файловых систем EFS

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

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	По умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	По умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url	По умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
encrypt (добавлен в 2.5)	Варианты: да нет ←	Булево значение, которое, если истинно, создает зашифрованную файловую систему. Это значение нельзя изменить после создания файловой системы.
id	По умолчанию: None	Идентификатор Amazon EFS. Для удаления требуется либо имя, либо идентификатор.
kms_key_id (добавлен в 2.5)		Идентификатор AWS KMS CMK, который будет использоваться для защиты зашифрованной файловой системы. Этот параметр необходим только если вы хотите использовать CMK, отличную от стандартной. Если этот параметр не указан, используется стандартный CMK для Amazon EFS. Идентификатор ключа может быть идентификатором ключа, ARN ключа, псевдонимом ключа или ARN псевдонима ключа.
name	По умолчанию: None	Токен создания файловой системы Amazon EFS. Требуется для создания и обновления. Для удаления требуется либо имя, либо идентификатор.
performance_mode	Варианты: general_purpose ← max_io	Режим производительности файловой системы. Действует только при создании.
profile (добавлен в 1.6)	По умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags (добавлен в 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)	По умолчанию: None	AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	Варианты: present ← absent	Позволяет создавать, искать и удалять файловые системы Amazon EFS
tags	По умолчанию: None	Список тегов Amazon EFS. Должен быть определен как словарь. В случае состояния 'present' со списком тегов и существующей EFS (соответствующей параметру 'name'), теги EFS будут заменены предоставленными данными.
targets	По умолчанию: None	Список подключенных целей. Должен быть списком словарей, каждый словарь должен содержать следующие атрибуты: - subnet_id - Обязательный. Идентификатор подсети, в которую добавить целевой mount. - ip_address - Необязательный. Действительный IPv4 адрес в диапазоне адресов указанной подсети. - security_groups - Необязательный. Список идентификаторов групп безопасности, в формате 'sg-xxxxxxxx'. Они должны относиться к одной VPC, что и указанная подсеть. Эти данные могут быть изменены для существующей EFS с использованием состояния 'present' и нового списка целевых mount.
validate_certs (добавлен в 1.5)	Варианты: нет да ←	При значении "нет", сертификаты SSL не будут проверятся для boto версий >= 2.6.0.
wait	Варианты: да нет ←	В случае состояния '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 список	всегда	список целевых точек подключения Пример: [{'mount_target_id': 'fsmt-d8907871', 'life_cycle_state': 'available', 'file_system_id': 'fs-a7ad440e', 'subnet_id': 'subnet-e265c895', 'network_interface_id': 'eni-6e387e26', 'ip_address': '172.31.17.173', 'security_groups': ['sg-a30b22c6'], 'owner_id': '740748460359'}, '...']
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'}

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.

Автор

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.5/modules/efs_module.html