модуль google.cloud.gcp_vertexai_tensorboard – создание ресурса GCP VertexAI.Tensorboard

Примечание

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

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

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

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

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

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

Tensorboard — это физическая база данных, в которой хранятся метрики обучения пользователей. В каждом регионе проекта GCP предоставляется Tensorboard по умолчанию. При необходимости пользователи также могут создавать дополнительные Tensorboard в своих проектах.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа, используемый для аутентификации.
auth_kind string / обязательный	Тип используемых учётных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
description string	Описание этого Tensorboard.
display_name string / обязательный	Имя этого Tensorboard, заданное пользователем.
encryption_spec dictionary	Спецификация ключа шифрования, управляемого клиентом, для Tensorboard. Если параметр задан, этот Tensorboard и все его вложенные ресурсы будут защищены этим ключом.
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	Метки с пользовательскими метаданными для упорядочивания Tensorboard.
project string	Проект Google Cloud Platform, который следует использовать.
region string	Регион Tensorboard. Например, us-central1.
scopes list / элементы=string	Массив областей доступа для использования.
service_account_contents jsonarg	Содержимое JSON-файла учётной записи службы, представленное в виде словаря или строки JSON.
service_account_email string	Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учётной записи службы, если в качестве типа выбран serviceaccount.
state string	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник по API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards
Официальное руководство по документации: https://cloud.google.com/vertex-ai/docs
Для аутентификации можно задать 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 Tensorboard
  google.cloud.gcp_vertexai_tensorboard:
    state: present
    display_name: my-tensorboard
    description: sample description
    labels:
      key1: value1
      key2: value2
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ	Описание
blobStoragePathPrefix string	Префикс пути Cloud Storage в проекте-потребителе, используемый для хранения двоичных данных; это может быть как корзина, так и каталог. Не заканчивается символом «/». Возвращается: при успешном выполнении
changed boolean	Был ли изменён ресурс. Возвращается: всегда
createTime string	Время создания Tensorboard в формате RFC3339 UTC «Zulu», с точностью до наносекунд и не более чем девятью дробными знаками. Возвращается: при успешном выполнении
name string	Имя Tensorboard. Возвращается: при успешном выполнении
runCount string	Количество запусков, сохранённых в этом Tensorboard. Возвращается: при успешном выполнении
state string	Текущее состояние ресурса. Возвращается: всегда
updateTime string	Время последнего обновления Tensorboard в формате 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_tensorboard_module.html