gcp_compute_instance_template_facts – Сбор фактов для GCP InstanceTemplate
Новое в версии 2.7.
Обзор
- Сбор фактов для GCP InstanceTemplate
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2) . | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое JSON-файла учетной записи службы. Это не должно передаваться как словарь, а как строка, содержащая точное содержимое файла json учетной записи службы (действительный JSON) | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить 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. - Значения переменных среды будут использоваться только в том случае, если значения в playбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a instance template facts"
gcp_compute_instance_template_facts:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Краткое описание полей | Возвращаемое значение | Описание | |||||
|---|---|---|---|---|---|---|---|
| items сложный тип | всегда | Список элементов | |||||
| creationTimestamp строка | успех | Маркер создания в формате RFC3339. | |||||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |||||
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | |||||
| name строка | успех | Имя ресурса. Длина имени составляет от 1 до 63 символов и соответствует RFC1035. | |||||
| properties сложный тип | успех | Свойства экземпляра для этой шаблона экземпляра. | |||||
| canIpForward булево | успех | Разрешает экземплярам, созданным на основе этого шаблона, отправлять пакеты с адресами источника, отличными от их собственных, и получать пакеты с адресами назначения, отличными от их собственных. Если эти экземпляры будут использоваться в качестве шлюза IP или будут установлены как следующий маршрут в ресурсе Route, укажите true. Если не уверены, оставьте это значение false. | |||||
| description строка | успех | Необязательное текстовое описание экземпляров, созданных из этого шаблона экземпляра. | |||||
| disks сложный тип | успех | Массив дисков, связанных с экземплярами, созданными из этого шаблона. | |||||
| autoDelete булево | успех | Указывает, будет ли диск автоматически удален при удалении экземпляра (но не при отсоединении диска от экземпляра). Совет: Диски следует устанавливать с autoDelete=true, чтобы после удаления машины не оставались лишние диски. | |||||
| boot булево | успех | Указывает, что это загрузочный диск. Виртуальная машина будет использовать первый раздел диска для своей корневой файловой системы. | |||||
| deviceName строка | успех | Указывает уникальное имя устройства по вашему выбору, которое отражается в дереве /dev/disk/by-id/google-* операционной системы Linux, работающей внутри экземпляра. Это имя можно использовать для ссылки на устройство для монтирования, изменения размера и т.д. изнутри экземпляра. | |||||
| diskEncryptionKey сложный тип | успех | Шифрует или расшифровывает диск с помощью предоставленного клиентом ключа шифрования. | |||||
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |||||
| rsaEncryptedKey строка | успех | Указывает закодированный в RFC 4648 base64, обернутый RSA, 2048-битный ключ шифрования, предоставленный клиентом, для шифрования или дешифрования этого ресурса. | |||||
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, защищающего этот ресурс. | |||||
| index целое число | успех | Назначает индекс с нулевым основанием этому диску, где 0 зарезервирован для загрузочного диска. Например, если к экземпляру подключено много дисков, каждый диск будет иметь уникальный номер индекса. Если не указано, сервер выберет соответствующее значение. | |||||
| initializeParams сложный тип | успех | Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания загрузочных дисков или локальных SSD, подключенных к новому экземпляру. | |||||
| diskName строка | успех | Указывает имя диска. Если не указано, по умолчанию используется имя экземпляра. | |||||
| diskSizeGb целое число | успех | Указывает размер диска в ГБ. | |||||
| diskType строка | успех | Ссылка на тип диска. Указывает тип диска для использования при создании экземпляра. Если не указано, по умолчанию используется pd-стандарт. | |||||
| sourceImage строка | успех | Изображение-источник для создания этого диска. При создании нового экземпляра требуется либо initializeParams.sourceImage, либо disks.source. Для создания диска с одним из общедоступных образов операционной системы укажите имя семейства образа. | |||||
| sourceImageEncryptionKey сложный тип | успех | Ключ шифрования, предоставленный клиентом, для образа-источника. Требуется, если образ-источник защищен ключом шифрования, предоставленным клиентом. Шаблоны экземпляров не хранят ключи шифрования, предоставленные клиентом, поэтому вы не можете создать диски для экземпляров в управляемой группе экземпляров, если образы-источники зашифрованы вашими ключами. | |||||
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | |||||
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, защищающего этот ресурс. | |||||
| interface строка | успех | Указывает интерфейс диска для подключения, который может быть SCSI или NVME. По умолчанию используется SCSI. Постоянные диски всегда должны использовать SCSI, и запрос завершится ошибкой, если вы попытаетесь подключить постоянный диск в другом формате, кроме SCSI. | |||||
| mode строка | успех | Режим подключения этого диска, либо READ_WRITE, либо READ_ONLY. Если не указано, по умолчанию диск подключается в режиме READ_WRITE. | |||||
| source словарь | успех | Ссылка на диск. При создании нового экземпляра требуется либо initializeParams.sourceImage, либо disks.source. При необходимости вы также можете подключить существующие постоянные диски, не являющиеся корневыми, с помощью этого свойства. Это поле применимо только для постоянных дисков. Обратите внимание, что для InstanceTemplate укажите имя диска, а не URL-адрес диска. | |||||
| тип строка | успех | Указывает тип диска, либо SCRATCH, либо PERSISTENT. Если не указано, по умолчанию используется PERSISTENT. | |||||
| guestAccelerators сложный | успех | Список типов и количества ускорителей, подключенных к экземпляру. | |||||
| acceleratorCount целое число | успех | Количество ускорителей гостевой ОС, доступных для этого экземпляра. | |||||
| acceleratorType строка | успех | Полный или частичный URL ресурса типа ускорителя, предоставляемого этому экземпляру. | |||||
| machineType строка | успех | Тип машины, используемый в шаблоне виртуальной машины. | |||||
| metadata словарь | успех | Ключевые пары метаданных, которые будут назначены экземплярам, созданным из этого шаблона. Эти пары могут содержать пользовательские метаданные или предопределенные ключи. | |||||
| minCpuPlatform строка | успех | Указывает минимальную платформу процессора для виртуальной машины. Допустимые значения — это описательные имена платформ процессоров. | |||||
| networkInterfaces сложный | успех | Массив конфигураций для этого интерфейса. Определяет, как этот интерфейс взаимодействует с другими сетевыми службами, например, для подключения к интернету. Для каждого экземпляра поддерживается только один сетевой интерфейс. | |||||
| accessConfigs сложный | успех | Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если accessConfigs не указаны, экземпляр не будет иметь внешнего доступа к интернету. | |||||
| имя строка | успех | Имя этой конфигурации доступа. Рекомендуемое значение по умолчанию — External NAT, но можно использовать любое произвольное имя. Например, Мой внешний IP-адрес или Сетевой доступ. | |||||
| natIP словарь | успех | Ссылка на адрес. Внешний IP-адрес, связанный с этим экземпляром. Укажите неиспользуемый статический внешний IP-адрес, доступный проекту, или оставьте это поле неопределенным, чтобы использовать IP-адрес из общего пула временных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в той же области, что и зона экземпляра. | |||||
| тип строка | успех | Тип конфигурации. По умолчанию и единственный вариант — ONE_TO_ONE_NAT. | |||||
| aliasIpRanges сложный | успех | Массив диапазонов IP-адресов псевдонима для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов на сетях в режиме подсети. | |||||
| ipCidrRange строка | успех | Диапазон IP CIDR, представленный этим диапазоном IP-адресов псевдонима. Этот диапазон IP CIDR должен принадлежать указанной подсети и не должен содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одним IP-адресом (например, 10.2.3.4), маской (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24). | |||||
| subnetworkRangeName строка | успех | Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого нужно выделить диапазон IP CIDR для этого диапазона IP-адресов псевдонима. Если не указано, будет использован основной диапазон подсети. | |||||
| имя строка | успех | Имя сетевого интерфейса, сгенерированное сервером. Для сетевых устройств — это eth0, eth1 и т. д. | |||||
| network словарь | успех | Указывает заголовок существующей сети. При создании экземпляра, если не указаны ни сеть, ни подсеть, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется. | |||||
| networkIP строка | успех | Внутренний IPv4-адрес сети, который нужно назначить экземпляру для этого сетевого интерфейса. Если не указан пользователем, система назначает неиспользуемый внутренний IP-адрес. | |||||
| subnetwork словарь | успех | Ссылка на сеть VPC. Если ресурс сети находится в режиме «старого» формата, не указывайте этот параметр. Если сеть находится в режиме автоматической подсети, указание подсети является необязательным. Если сеть находится в режиме пользовательской подсети, этот параметр должен быть указан. | |||||
| scheduling сложный | успех | Устанавливает параметры планирования для этого экземпляра. | |||||
| automaticRestart логическое | успех | Указывает, следует ли автоматически перезапускать экземпляр, если он был завершён Compute Engine (но не пользователем). Параметр автоматического перезапуска можно установить только для стандартных экземпляров. Предварительные экземпляры не могут быть автоматически перезапущены. | |||||
| onHostMaintenance строка | успех | Определяет поведение при обслуживании узла для этого экземпляра. Для стандартных экземпляров по умолчанию используется поведение MIGRATE. Для предварительных экземпляров по умолчанию и единственное возможное поведение — TERMINATE. Дополнительную информацию см. в разделе Настройка параметров планирования экземпляра. | |||||
| preemptible логическое | успех | Определяет, является ли экземпляр предварительным. Это можно задать только при создании экземпляра, изменить после создания нельзя. | |||||
| serviceAccounts сложный | успех | Список учётных записей служб со спецификацией областей, авторизованных для этого экземпляра. Для каждого экземпляра виртуальной машины поддерживается только одна учётная запись службы. | |||||
| email строка | успех | Электронный адрес учётной записи службы. | |||||
| scopes список | успех | Список областей, которые будут доступны для этой учётной записи службы. | |||||
| tags сложный | успех | Список тегов, которые нужно применить к этому экземпляру. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом при создании экземпляра. Позже теги можно изменить методом setTags. Каждый тег в списке должен соответствовать RFC1035. | |||||
| fingerprint string | success | Указывает отпечаток для этого запроса, который представляет собой хэш содержимого метаданных и используется для оптимистической блокировки. Отпечаток изначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных вы всегда должны указать актуальный хэш отпечатка. | |||||
| items list | success | Массив тегов. Каждый тег должен быть длиной от 1 до 63 символов и соответствовать RFC1035. | |||||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_instance_template_facts_module.html
