gcp_compute_address – Создаёт адрес GCP
Новая версия с 2.6.
Описание
- Представляет ресурс типа «Адрес».
- Каждый виртуальный экземпляр машины имеет временный внутренний 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 |
| Тип адреса для резервирования, либо INTERNAL, либо EXTERNAL. Если не указано, используется значение по умолчанию EXTERNAL. |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description - | Необязательное описание этого ресурса. | |
| name - / обязательно | Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network_tier - добавлено в 2.8 |
| Используемый уровень сети для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, предполагается, что оно равно PREMIUM. |
| project строка | Проект Google Cloud Platform для использования. | |
| region - / обязательно | URL региона, в котором находится региональный адрес. Это поле не применяется к глобальным адресам. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла json учетной записи службы (корректный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | |
| state - |
| Нужно ли данному объекту существовать в GCP |
| subnetwork - добавлено в 2.7 | URL подсети, в которой нужно зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Это поле может использоваться только с типом INTERNAL для целей GCE_ENDPOINT/DNS_RESOLVER. Это поле представляет ссылку на ресурс подсети в 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, используя переменную среды
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 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 ресурсов, использующих этот адрес. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [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_address_module.html