gcp_compute_network – Создаёт сеть GCP
Новая в версии 2.6.
Обзор
- Управляет ресурсом сети VPC или устаревшей сетью в GCP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| auto_create_subnetworks булево |
| При установке в `true`, сеть создаётся в режиме «автоматическое создание подсетей», и для каждого региона будет автоматически создана подсеть в диапазоне адресов `10.128.0.0/9`. При установке в `false`, сеть создаётся в режиме «пользовательское создание подсетей», и пользователь может явно подключить ресурсы подсетей. | |
| description - | Необязательное описание этого ресурса. Для изменения этого поля необходимо пересоздать ресурс. | ||
| ipv4_range - | Если это поле указано, создаётся устаревшая сеть. Создание устаревших сетей больше не поддерживается с 1 февраля 2020 года. Для получения дополнительной информации см. [документацию по устаревшим сетям](https://cloud.google.com/vpc/docs/legacy). Диапазон внутренних адресов, допустимых в этой устаревшей сети. Этот диапазон задаётся в формате CIDR, например: `192.168.0.0/16`. Для изменения этого поля необходимо пересоздать ресурс. | ||
| name - / обязательно | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project строка | Проект Google Cloud Platform, который нужно использовать. | ||
| routing_config - добавлен в 2.8 | Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации во всей сети. | ||
| routing_mode - / обязательно |
| Режим маршрутизации для всей сети. Если установлено `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети в разных регионах. | |
| scopes список | Массив используемых областей. | ||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла service account json (действительный JSON). | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран `machineaccount`, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана учетная запись службы. | ||
| state - |
| Нужно ли существование данного объекта в GCP | |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/networks
- Официальная документация: https://cloud.google.com/vpc/docs/vpc
- Для аутентификации можно установить 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. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
gcp_compute_network:
name: test_object
auto_create_subnetworks: 'true'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| autoCreateSubnetworks булево | success | При установке в `true`, сеть создаётся в режиме «автоматическое создание подсетей», и для каждого региона будет автоматически создана подсеть в диапазоне адресов `10.128.0.0/9`. При установке в `false`, сеть создаётся в режиме «пользовательское создание подсетей», и пользователь может явно подключить ресурсы подсетей. | |
| creationTimestamp строка | success | Время создания в формате RFC3339. | |
| description строка | success | Необязательное описание этого ресурса. Для изменения этого поля необходимо пересоздать ресурс. | |
| gateway_ipv4 строка | success | Адрес шлюза для маршрутизации по умолчанию из сети. Это значение выбирается GCP. | |
| id целое число | success | Уникальный идентификатор ресурса. | |
| ipv4_range строка | success | Если это поле указано, создаётся устаревшая сеть. Создание устаревших сетей больше не поддерживается с 1 февраля 2020 года. Для получения дополнительной информации см. [документацию по устаревшим сетям](https://cloud.google.com/vpc/docs/legacy). Диапазон внутренних адресов, допустимых в этой устаревшей сети. Этот диапазон задаётся в формате CIDR, например: `192.168.0.0/16`. Для изменения этого поля необходимо пересоздать ресурс. | |
| name строка | success | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| routingConfig сложный тип | success | Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации во всей сети. | |
| routingMode строка | success | Режим маршрутизации для всей сети. Если установлено `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети в разных регионах. | |
| subnetworks список | success | Определённые сервером полные URL-адреса всех подсетей в этой сети. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_network_module.html