gcp_compute_ssl_policy – Создаёт политику SSL GCP
Новая в версии 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 - | Необязательное описание данного ресурса. | |
| 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 с клиентами. Может принимать значения `COMPATIBLE`, `MODERN`, `RESTRICTED` или `CUSTOM`. При использовании `CUSTOM` набор функций SSL, которые необходимо включить, должен быть указан в поле `customFeatures`. |
| project строка | Проект Google Cloud Platform, который использовать. | |
| scopes список | Массив используемых областей видимости. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Этот параметр не должен передаваться как словарь, а как строка с точным содержимым файла JSON учетной записи службы (корректный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана учетная запись службы. | |
| 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_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать 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.8/modules/gcp_compute_ssl_policy_module.html