gcp_compute_global_address – Создаёт GCP GlobalAddress
Новая версия с 2.6.
Обзор
- Представляет ресурс 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 указывает на публичный/внешний единственный IP-адрес. * INTERNAL указывает на внутренние IP-диапазоны, принадлежащие к какой-либо сети. |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description - | Необязательное описание этого ресурса. | |
| ip_version - |
| Версия IP, которая будет использоваться этим адресом. Допустимые значения: `IPV4` или `IPV6`. Значение по умолчанию `IPV4`. |
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи сервиса. Не следует передавать это как словарь, а строку с точным содержимым файла 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, используя переменную среды
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 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])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| region строка | успех | Ссылка на регион, в котором находится региональный адрес. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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_global_address_module.html