gcp_compute_address – Создаёт адрес GCP
Новая версия с 2.6.
Описание
- Представляет ресурс Address.
- У каждого виртуального машинного экземпляра есть временный внутренний IP-адрес и, необязательно, внешний IP-адрес. Для связи между экземплярами в одной сети можно использовать внутренний IP-адрес экземпляра. Для связи с Интернетом и экземплярами за пределами одной сети необходимо указать внешний IP-адрес экземпляра.
- Внутренние IP-адреса временные и принадлежат экземпляру только на время его существования; если экземпляр удаляется и создается заново, экземпляру назначается новый внутренний IP-адрес, либо Compute Engine, либо вами. Внешние IP-адреса могут быть либо временными, либо статическими.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address строка | Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться в указанной подсети, если таковая имеется. | |
| address_type строка добавлено в 2.7 | По умолчанию: "EXTERNAL" | Тип адреса для резервирования, либо INTERNAL, либо EXTERNAL. Если не указан, по умолчанию устанавливается EXTERNAL. Некоторые допустимые значения: "INTERNAL", "EXTERNAL" |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description строка | Необязательное описание этого ресурса. | |
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API. | |
| name строка / обязательно | Имя ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network_tier строка добавлено в 2.8 | Используемый уровень сети для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, предполагается, что это PREMIUM. Некоторые допустимые значения: "PREMIUM", "STANDARD" | |
| project строка | Проект Google Cloud Platform для использования. | |
| region строка / обязательно | URL региона, в котором находится региональный адрес. Это поле не применимо к глобальным адресам. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержание файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран. | |
| state строка |
| Существует ли заданный объект в GCP |
| subnetwork словарь добавлено в 2.7 | URL подсети, в которой необходимо зарезервировать адрес. Если IP-адрес указан, он должен находиться в диапазоне IP-адресов подсети. Это поле может быть использовано только с типом INTERNAL для целей GCE_ENDPOINT/DNS_RESOLVER. Это поле представляет ссылку на ресурс Subnetwork в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Или же вы можете добавить `register: имя-ресурса` в задачу gcp_compute_subnetwork, а затем установить это поле subnetwork в "{{ имя-ресурса }}" |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/beta/addresses
- Резервирование статического внешнего IP-адреса: https://cloud.google.com/compute/docs/instances-and-network
- Резервирование статического внутреннего IP-адреса: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-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. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a address
gcp_compute_address:
name: test-address1
region: us-west1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address строка | успешно | Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться внутри указанной подсети, если таковая есть. |
| addressType строка | успешно | Тип адреса для резервирования, либо INTERNAL, либо EXTERNAL. Если не указано, по умолчанию используется EXTERNAL. |
| creationTimestamp строка | успешно | Дата и время создания в формате RFC3339. |
| description строка | успешно | Необязательное описание этого ресурса. |
| id целое число | успешно | Уникальный идентификатор ресурса. |
| name строка | успешно | Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Конкретно, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. |
| networkTier строка | успешно | Уровень сети, используемый для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, оно предполагается PREMIUM. |
| region строка | успешно | URL региона, в котором находится региональный адрес. Это поле не применимо к глобальным адресам. |
| subnetwork словарь | успешно | URL подсети, в которой следует зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Это поле может использоваться только с типом INTERNAL с целями GCE_ENDPOINT/DNS_RESOLVER. |
| users список | успешно | URL ресурсов, использующих этот адрес. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/gcp_compute_address_module.html
