Модуль google.cloud.gcp_compute_ssl_policy — создание SslPolicy в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: 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
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учётных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
custom_features list / элементы=string | Список функций, включаемых при выборе профиля CUSTOM. Метод возвращает набор функций, которые можно указать в этом списке. Если профиль не CUSTOM, это поле должно быть пустым. |
description string | Необязательное описание этого ресурса. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. |
min_tls_version string | Минимальная версия протокола SSL, которую клиенты могут использовать для установления соединения с балансировщиком нагрузки. Допустимые значения: «TLS_1_0», «TLS_1_1», «TLS_1_2» |
name string / обязательный | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, оно должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. |
profile string | Профиль задаёт набор функций SSL, которые балансировщик нагрузки может использовать при согласовании SSL с клиентами. Если используется `CUSTOM`, набор включаемых функций SSL необходимо указать в поле `customFeatures`. Допустимые значения: «COMPATIBLE», «MODERN», «RESTRICTED», «CUSTOM» |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учётной записи службы в виде словаря или строки JSON, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учётной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount. |
state string | Должен ли указанный объект существовать в 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. - Для аутентификации можно задать access_token с помощью переменной окружения
GCP_ACCESS_TOKEN. - Для аутентификации можно задать 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 string | Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
customFeatures list / элементы=string | Список функций, включаемых при выборе профиля CUSTOM. Метод возвращает набор функций, которые можно указать в этом списке. Если профиль не CUSTOM, это поле должно быть пустым. Возвращается: при успехе |
description string | Необязательное описание этого ресурса. Возвращается: при успехе |
enabledFeatures list / элементы=string | Список функций, включённых в политике SSL. Возвращается: при успехе |
fingerprint string | Отпечаток этого ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется для оптимистичной блокировки. Возвращается: при успехе |
id integer | Уникальный идентификатор ресурса. Возвращается: при успехе |
minTlsVersion string | Минимальная версия протокола SSL, которую клиенты могут использовать для установления соединения с балансировщиком нагрузки. Возвращается: при успехе |
name string | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, оно должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
profile string | Профиль задаёт набор функций SSL, которые балансировщик нагрузки может использовать при согласовании SSL с клиентами. Если используется `CUSTOM`, набор включаемых функций SSL необходимо указать в поле `customFeatures`. Возвращается: при успехе |
warnings complex | Если для этой политики SSL обнаружены потенциальные ошибки конфигурации, это поле будет содержать предупреждения. Возвращается: при успехе |
|
code string |
Код предупреждения, если применимо. Возвращается: при успехе |
|
message string |
Понятное пользователю описание кода предупреждения. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_ssl_policy_module.html