Модуль google.cloud.gcp_vertexai_index_endpoint — создание ресурса GCP VertexAI.IndexEndpoint

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_vertexai_index_endpoint.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Конечная точка, в которую развёртываются индексы. Конечная точка индекса может содержать несколько развёрнутых индексов.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.8
requests >= 2.18.4
google-auth >= 2.25.1

Параметры

Параметр	Комментарии
access_token string	Токен доступа, используемый для аутентификации.
auth_kind string / обязательный	Тип используемых учётных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
description string	Описание индекса.
display_name string / обязательный	Отображаемое имя индекса. Имя может содержать не более 128 символов и состоять из любых символов UTF-8.
encryption_spec dictionary	Спецификация ключа шифрования, управляемого клиентом, для IndexEndpoint. Если указано это значение, данный IndexEndpoint и все его подресурсы будут защищены этим ключом.
kms_key_name string / обязательный	Идентификатор ресурса Cloud KMS для ключа шифрования, управляемого клиентом и используемого для защиты ресурса. Имеет следующий формат: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. Ключ должен находиться в том же регионе, в котором создаётся вычислительный ресурс.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для любых запросов к API.
labels dictionary	Метки с определёнными пользователем метаданными для упорядочивания индексов.
network string	Полное имя [сети](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) Google Compute Engine, с которой должна быть установлена пиринговая связь для конечной точки индекса. Для сети уже должен быть настроен частный доступ к сервисам. Если значение не указано, для конечной точки индекса не устанавливается пиринговая связь ни с одной сетью. [Формат](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Здесь `{project}` — номер проекта, например `12345`, а `{network}` — имя сети.
private_service_connect_config dictionary	Конфигурация Private Service Connect. `network` и `privateServiceConnectConfig` являются взаимоисключающими параметрами.
enable_private_service_connect boolean / обязательный	Если установлено значение true, IndexEndpoint создаётся без частного доступа к сервисам. Варианты: `false` `true`
project_allowlist list / элементы=string	Список проектов, из которых правило переадресации будет направлять трафик к подключению сервиса.
psc_automation_configs list / элементы=dictionary	Список проектов и сетей, в которых будут созданы конечные точки PSC. Это поле используется только для онлайн-вывода (прогнозирования).
network string / обязательный	Полное имя [сети](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) Google Compute Engine. [Формат](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): projects/{project}/global/networks/{network}.
project_id string / обязательный	Идентификатор проекта, используемый для создания правила переадресации.
project string	Проект Google Cloud Platform, который следует использовать.
public_endpoint_enabled boolean	Если значение равно true, развёрнутый индекс будет доступен через общедоступную конечную точку. Варианты: `false` `true`
region string	Регион конечной точки индекса. Например, us-central1.
scopes list / элементы=string	Массив областей действия, которые следует использовать.
service_account_contents jsonarg	Содержимое JSON-файла сервисного аккаунта в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты сервисного аккаунта, если выбрана учётная запись машины и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбран serviceaccount.
state string	Указывает, должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email, service_account_file, service_account_file и access_token являются взаимоисключающими.

Примеры

- name: Create Index Endpoint
  google.cloud.gcp_vertexai_index_endpoint:
    state: present
    display_name: myidxep
    region: us-central1
    network: "projects/{{ gcp_project_number }}/global/networks/{{ mynet }}"  # Network must be peered
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

################################################################################

- name: Create Index Endpoint with public endpoint
  google.cloud.gcp_vertexai_index_endpoint:
    state: present
    display_name: "{{ resource_name }}"
    region: us-central1
    public_endpoint_enabled: true  # public endpoints don't require VPC network
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда
createTime string	Время создания индекса в формате RFC3339 UTC «Zulu» с точностью до наносекунд и максимум девятью цифрами в дробной части. Возвращается: при успехе
etag string	Используется для согласованных операций чтения, изменения и записи. Возвращается: при успехе
name string	Имя ресурса индекса. Возвращается: при успехе
publicEndpointDomainName string	Если publicEndpointEnabled равно true, это поле будет содержать доменное имя, используемое для данной конечной точки индекса. Возвращается: при успехе
state string	Текущее состояние ресурса. Возвращается: всегда
updateTime string	Время последнего обновления индекса в формате RFC3339 UTC «Zulu» с точностью до наносекунд и максимум девятью цифрами в дробной части. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_vertexai_index_endpoint_module.html