gcp_compute_global_address – Создаёт GCP GlobalAddress
Новая в версии 2.6.
Описание
- Представляет ресурс Global Address. Global Address используются для балансировки нагрузки HTTP(S).
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address строка добавлен в 2.8 | Статический внешний IP-адрес, представленный этим ресурсом. | |
| address_type строка добавлен в 2.8 | По умолчанию: "EXTERNAL" | Тип адреса для резервирования, по умолчанию EXTERNAL. * EXTERNAL указывает на публичный/внешний единственный IP-адрес. * INTERNAL указывает на внутренние IP-диапазоны, принадлежащие некоторой сети. Допустимые значения: "EXTERNAL", "INTERNAL" |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description строка | Необязательное описание этого ресурса. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это следует устанавливать только если вы знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | |
| ip_version строка | IP-версия, которая будет использоваться этим адресом. Допустимые значения: `IPV4` или `IPV6`. Значение по умолчанию `IPV4`. Допустимые значения: "IPV4", "IPV6" | |
| name строка / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчными буквами или цифрами, за исключением последнего символа, который не может быть тире. | |
| network словарь добавлен в 2.9 | URL сети, в которой необходимо зарезервировать IP-диапазон. IP-диапазон должен находиться в пространстве RFC1918. Сеть нельзя удалить, если к ней есть какие-либо зарезервированные IP-диапазоны. Этот параметр следует задавать только при использовании внутреннего адреса. Этот параметр представляет ссылку на ресурс сети в GCP. Он может быть указан двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем задать этот параметр network со значением "{{ имя-ресурса }}" | |
| prefix_length целое число добавлен в 2.9 | Длина префикса IP-диапазона. Если параметр отсутствует, это означает, что адрес является единственным IP-адресом. Этот параметр не применим к адресам с addressType=EXTERNAL. | |
| project строка | Проект Google Cloud Platform, который следует использовать. | |
| purpose строка добавлен в 2.9 | Назначение ресурса. Для глобальных внутренних адресов может быть * VPC_PEERING — для сетей-партнеров. Этот параметр следует задавать только при использовании внутреннего адреса. Допустимые значения: "VPC_PEERING" | |
| 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/v1/globalAddresses
- Резервирование статического внешнего IP-адреса: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address
- для аутентификации можно установить 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. - Значения переменных среды будут использоваться только в том случае, если значения в playбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a global address
gcp_compute_global_address:
name: test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address строка | успех | Статический внешний IP-адрес, представленный этим ресурсом. |
| addressType строка | успех | Тип адреса для резервирования, по умолчанию EXTERNAL. * EXTERNAL указывает на общедоступный/внешний одиночный IP-адрес. * INTERNAL указывает на внутренние IP-диапазоны, принадлежащие какой-либо сети. |
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. |
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. |
| ipVersion строка | успех | Версия IP, которая будет использоваться этим адресом. Допустимые значения: `IPV4` или `IPV6`. По умолчанию `IPV4`. |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| network словарь | успех | URL сети, в которой нужно зарезервировать IP-диапазон. IP-диапазон должен быть в пространстве RFC1918. Сеть не может быть удалена, если на неё ссылаются какие-либо зарезервированные IP-диапазоны. Это поле должно быть задано только при использовании внутреннего адреса. |
| prefixLength целое число | успех | Длина префикса IP-диапазона. Если поле отсутствует, это означает, что поле адрес представляет собой отдельный IP-адрес. Это поле не применимо к адресам с addressType=EXTERNAL. |
| purpose строка | успех | Назначение ресурса. Для глобальных внутренних адресов это может быть * VPC_PEERING — для сетей-партнёров. Это поле должно быть задано только при использовании внутреннего адреса. |
| region строка | успех | Ссылка на регион, в котором находится региональный адрес. |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_global_address_module.html
