google.cloud.gcp_compute_ssl_policy – Создаёт политику GCP SslPolicy
Примечание
Этот плагин является частью коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_compute_ssl_policy.
Обзор
- Представляет политику SSL. Политики SSL позволяют управлять функциями SSL, которые переговариваются вашим прокси-сервером SSL или балансировщиком нагрузки HTTPS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| custom_features список / элементы=строка | Список функций, включенных, когда выбран профиль CUSTOM. Метод возвращает набор функций, которые могут быть указаны в этом списке. Это поле должно быть пустым, если профиль не CUSTOM. | |
| description строка | Необязательное описание этого ресурса. | |
| env_type строка | Указывает, в какой среде Ansible вы работаете с этим модулем. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| min_tls_version строка | Минимальная версия протокола SSL, которую могут использовать клиенты для подключения к балансировщику нагрузки. Некоторые допустимые варианты: "TLS_1_0", "TLS_1_1", "TLS_1_2" | |
| name строка / обязательно | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов, а имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| profile строка | Профиль определяет набор функций SSL, которые может использовать балансировщик нагрузки при переговор SSL с клиентами. При использовании `CUSTOM` набор функций SSL для включения должен быть указан в поле `customFeatures`. Некоторые допустимые варианты: "COMPATIBLE", "MODERN", "RESTRICTED", "CUSTOM" | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список / элементы=строка | Массив областей, которые будут использоваться | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | |
| state строка |
| Требуется ли наличие объекта в GCP |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies
- Использование политик SSL: https://cloud.google.com/compute/docs/load-balancing/ssl-policies
- для аутентификации можно установить service_account_file, используя переменную среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a SSL policy
google.cloud.gcp_compute_ssl_policy:
name: test_object
profile: CUSTOM
min_tls_version: TLS_1_2
custom_features:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие значения возврата описаны в разделе здесь. Следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| creationTimestamp строка | success | Дата и время создания в формате RFC3339. | |
| customFeatures список / элементы=строка | success | Список функций, включенных, когда выбран профиль CUSTOM. Метод возвращает набор функций, которые могут быть указаны в этом списке. Это поле должно быть пустым, если профиль не CUSTOM. | |
| description строка | success | Необязательное описание этого ресурса. | |
| enabledFeatures список / элементы=строка | success | Список функций, включенных в политику SSL. | |
| fingerprint строка | success | Отпечаток ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется в оптимистической блокировке. | |
| id целое число | success | Уникальный идентификатор ресурса. | |
| minTlsVersion строка | success | Минимальная версия протокола SSL, которую могут использовать клиенты для подключения к балансировщику нагрузки. | |
| name строка | success | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов, а имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| profile строка | success | Профиль определяет набор функций SSL, которые может использовать балансировщик нагрузки при переговор SSL с клиентами. При использовании `CUSTOM` набор функций SSL для включения должен быть указан в поле `customFeatures`. | |
| warnings сложная структура | success | Если для этой политики SSL обнаружены потенциальные ошибки конфигурации, это поле будет заполнено предупреждающими сообщениями. | |
| code строка | success | Код предупреждения, если применимо. | |
| message строка | success | Текстовое описание кода предупреждения. | |
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_ssl_policy_module.html