google.cloud.gcp_appengine_firewall_rule – Создаёт правило брандмауэра GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_appengine_firewall_rule.
Описание
- Единственное правило брандмауэра, которое оценивает входящий трафик и определяет действие для обработанных запросов.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка / обязательно | Действие, которое необходимо выполнить, если это правило соответствует запросу. Некоторые допустимые значения: "UNSPECIFIED_ACTION", "ALLOW", "DENY" | |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description строка | Необязательное текстовое описание правила. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это влияет только на строку User Agent для API-запросов. | |
| priority целое число | Положительное целое число, определяющее порядок оценки правил. Правила с более низким приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем IPv4 и IPv6 трафику, если не соответствует предыдущее правило. Только действие этого правила может быть изменено пользователем. | |
| project строка | Проект Google Cloud Platform, который следует использовать. | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как JSON-строка, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | |
| source_range строка / обязательно | IP-адрес или диапазон, определенный с помощью CIDR-нотации, запросов, к которым применяется это правило. | |
| state строка |
| Следует ли данному объекту существовать в GCP |
Примечания
Примечание
- API-ссылка: https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.firewall.ingressRules
- Официальная документация: https://cloud.google.com/appengine/docs/standard/python/creating-firewalls#creating_firewall_rules
- для аутентификации можно установить 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 firewall rule
google.cloud.gcp_appengine_firewall_rule:
priority: 1000
source_range: 10.0.0.0
action: ALLOW
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| action строка | success | Действие, которое необходимо выполнить, если это правило соответствует запросу. |
| description строка | success | Необязательное текстовое описание правила. |
| priority целое число | success | Положительное целое число, определяющее порядок оценки правил. Правила с более низким приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем IPv4 и IPv6 трафику, если не соответствует предыдущее правило. Только действие этого правила может быть изменено пользователем. |
| sourceRange строка | success | IP-адрес или диапазон, определенный с помощью CIDR-нотации, запросов, к которым применяется это правило. |
Авторы
- 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_appengine_firewall_rule_module.html
