Модуль google.cloud.gcp_colab_runtime_template — создание ресурса GCP Colab.RuntimeTemplate

Примечание

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

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

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

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

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

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

«Шаблон среды выполнения — это конфигурация виртуальной машины, в которой указаны тип машины и другие характеристики виртуальной машины,
а также общие настройки, например сеть и наличие доступа к общедоступному Интернету. При создании
среды выполнения её виртуальная машина создаётся в соответствии со спецификациями шаблона среды выполнения».

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа, используемый для аутентификации.
auth_kind строка / обязательный	Тип используемых учётных данных. Допустимые значения: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
data_persistent_disk_spec словарь	Конфигурация диска данных среды выполнения.
disk_size_gb строка	Размер диска среды выполнения в ГБ. Если этот параметр указан, необходимо также указать diskType. Минимальный размер — 10 ГБ, максимальный — 65536 ГБ.
disk_type строка	Тип постоянного диска.
description строка	Описание шаблона среды выполнения.
display_name строка / обязательный	Отображаемое имя шаблона среды выполнения.
encryption_spec словарь	Спецификация ключа шифрования, управляемого заказчиком, для среды выполнения блокнота.
kms_key_name строка	Ключ шифрования Cloud KMS (ключ шифрования, управляемый заказчиком), используемый для защиты среды выполнения.
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов API.
euc_config словарь	Конфигурация EUC для NotebookRuntimeTemplate.
euc_disabled логическое значение	Отключить доступ среды выполнения к учётным данным конечного пользователя. Допустимые значения: `false` `true`
idle_shutdown_config словарь	Конфигурация автоматического завершения работы блокнота при простое для среды выполнения.
idle_timeout строка	Время, по истечении которого работа среды выполнения автоматически завершается. Значение 0s отключает автоматическое завершение работы при простое. Допустимый диапазон — [10m, 24h].
labels словарь	Метки для идентификации и группировки шаблона среды выполнения.
location строка / обязательный	Местоположение ресурса: https://cloud.google.com/colab/docs/locations.
machine_spec словарь	«Конфигурация машины среды выполнения».
accelerator_count целое число	Количество ускорителей, используемых средой выполнения.
accelerator_type строка	Тип аппаратного ускорителя, используемого средой выполнения. Если этот параметр указан, необходимо также указать acceleratorCount.
machine_type строка	Тип машины Compute Engine, выбранный для среды выполнения.
name строка / обязательный	Имя ресурса шаблона среды выполнения.
network_spec словарь	Конфигурация сети для среды выполнения.
enable_internet_access логическое значение	Включить для среды выполнения доступ к общедоступному Интернету. Допустимые значения: `false` `true`
network строка	Имя VPC, в которой находится эта среда выполнения.
subnetwork строка	Имя подсети, в которой находится эта среда выполнения.
network_tags список / элементы=строки	Применяет указанные теги Compute Engine к среде выполнения.
project строка	Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строки	Массив используемых областей доступа.
service_account_contents аргумент JSON	Содержимое JSON-файла учётной записи службы: словарь или строка JSON, представляющая его.
service_account_email строка	Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount.
shielded_vm_config словарь	Спецификация защищённой виртуальной машины для среды выполнения.
enable_secure_boot логическое значение	Включает безопасную загрузку для среды выполнения. Допустимые значения: `false` `true`
software_config словарь	Конфигурация программного обеспечения блокнота для среды выполнения блокнота.
env список / элементы=словарь	Переменные среды, передаваемые контейнеру.
name строка	Имя переменной среды. Должно быть допустимым идентификатором C.
value строка	Ссылки вида $(VAR_NAME) подставляются с использованием ранее определённых переменных среды контейнера и любых переменных среды службы. Если переменную разрешить не удаётся, ссылка во входной строке остаётся без изменений. Синтаксис $(VAR_NAME) можно экранировать двойным знаком $, например: $$(VAR_NAME). Экранированные ссылки никогда не подставляются независимо от того, существует переменная или нет.
post_startup_script_config словарь	Конфигурация скрипта, запускаемого после запуска.
post_startup_script строка	Скрипт, выполняемый после запуска среды выполнения.
post_startup_script_behavior строка	Поведение скрипта, запускаемого после запуска, определяющее способ загрузки и выполнения. Допустимые значения: `"RUN_ONCE"` `"RUN_EVERY_START"` `"DOWNLOAD_AND_RUN_EVERY_START"`
post_startup_script_url строка	URL скрипта, запускаемого после запуска, для загрузки. Пример: https://bucket/script.sh.
state строка	Должен ли ресурс существовать в GCP. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimeTemplates
Руководство по созданию шаблона среды выполнения: https://cloud.google.com/colab/docs/create-runtime-template
Для аутентификации можно задать 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 Basic Runtime Template
  google.cloud.gcp_colab_runtime_template:
    display_name: my-runtime-template
    state: present
    location: us-central1
    machine_spec:
      machine_type: n1-standard-4
    network_spec:
      enable_internet_access: true
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ	Описание
changed логическое значение	Был ли изменён ресурс. Возвращается: всегда
state строка	Текущее состояние ресурса. Возвращается: всегда

Авторы

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_colab_runtime_template_module.html