gcp_compute_ssl_policy – Создаёт политику GCP SslPolicy
Новая в версии 2.7.
Описание
- Представляет политику 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`. Некоторые допустимые значения: "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 с клиентами. Может быть `COMPATIBLE`, `MODERN`, `RESTRICTED` или `CUSTOM`. Если используется `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, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a SSL policy
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 строка | успех | Время создания в формате RFC3339. | |
| customFeatures список | успех | Список функций, включённых при выбранном профиле CUSTOM. Метод возвращает набор функций, которые можно указать в этом списке. Это поле должно быть пустым, если профиль не CUSTOM. | |
| description строка | успех | Необязательное описание этого ресурса. | |
| enabledFeatures список | успех | Список включённых функций в политике SSL. | |
| fingerprint строка | успех | Отпечаток этого ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| minTlsVersion строка | успех | Минимальная версия протокола 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 с клиентами. Может быть `COMPATIBLE`, `MODERN`, `RESTRICTED` или `CUSTOM`. Если используется `CUSTOM`, набор функций SSL, которые нужно включить, должен быть указан в поле `customFeatures`. | |
| warnings сложный тип | успех | Если для этой политики SSL обнаружены потенциальные ошибки конфигурации, это поле будет заполнено предупреждающими сообщениями. | |
| code строка | успех | Код предупреждения, если применимо. | |
| message строка | успех | Человекопонятное описание кода предупреждения. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_ssl_policy_module.html
