community.aws.iam_cert – Управление сертификатами сервера для использования в ELBs и CloudFront
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач, укажите: community.aws.iam_cert.
Введено в версии 1.0.0: of community.aws
Обзор
- Позволяет управлять сертификатами сервера.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- boto
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и будет считаться исключающими друг друга после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с набором CA-сертификатов для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Набор CA-сертификатов читается на стороне «модуля» и может потребоваться явно скопировать его с контроллера, если он не запускается локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ «user_agent». Дополнительные параметры конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и будет считаться исключающими друг друга после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| cert строка | Путь к файлу или содержимое тела сертификата в формате PEM. С версии 2.4 допускается ввод содержимого. Если параметр не является файлом, предполагается, что это содержимое. | |
| cert_chain строка | Путь к файлу или содержимое цепочки сертификатов CA в формате PEM. С версии 2.4 допускается ввод содержимого. Если параметр не является файлом, предполагается, что это содержимое. | |
| debug_botocore_endpoint_logs булево |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, выполненный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| dup_ok булево |
| По умолчанию модуль не загрузит сертификат, который уже загружен в AWS. Если dup_ok=True, он загрузит сертификат, если имя уникально. По умолчанию false. |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| key строка | Путь к файлу или содержимое закрытого ключа в формате PEM. С версии 2.4 допускается ввод содержимого. Если параметр не является файлом, предполагается, что это содержимое. | |
| name строка / обязательно | Имя добавляемого, обновляемого или удаляемого сертификата. | |
| new_name строка | Когда state=present, это обновит имя сертификата. Параметры cert, key и cert_chain будут проигнорированы, если этот параметр определён. | |
| new_path строка | Когда state=present, это обновит путь к сертификату. Параметры cert, key и cert_chain будут проигнорированы, если этот параметр определён. | |
| path строка | По умолчанию: "/" | При создании или обновлении укажите требуемый путь к сертификату. |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка одновременного указания их вместе с profile устарела.
aws_access_key, aws_secret_key и security_token будут считаться взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и будет считаться взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка / обязательно |
| Создать (или обновить) или удалить сертификат. Если заданы new_path или new_name, установка present попытается выполнить обновление. |
| validate_certs булево |
| Если установлено «нет», SSL-сертификаты не будут проверяться для boto версий >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
- name: Basic server certificate upload from local file
community.aws.iam_cert:
name: very_ssl
state: present
cert: "{{ lookup('file', 'path/to/cert') }}"
key: "{{ lookup('file', 'path/to/key') }}"
cert_chain: "{{ lookup('file', 'path/to/certchain') }}"
- name: Basic server certificate upload
community.aws.iam_cert:
name: very_ssl
state: present
cert: path/to/cert
key: path/to/key
cert_chain: path/to/certchain
- name: Server certificate upload using key string
community.aws.iam_cert:
name: very_ssl
state: present
path: "/a/cert/path/"
cert: body_of_somecert
key: vault_body_of_privcertkey
cert_chain: body_of_myverytrustedchain
- name: Basic rename of existing certificate
community.aws.iam_cert:
name: very_ssl
new_name: new_very_ssl
state: present
Авторы
- Jonathan I. Davila (@defionscode)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/iam_cert_module.html