Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

  • «Среда выполнения — это виртуальная машина (VM), предоставленная Google, которая может выполнять код из вашей записной книжки (файла IPYNB)».

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа, используемый для аутентификации.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "accesstoken"
  • "application"
  • "machineaccount"
  • "serviceaccount"

auto_upgrade

boolean

Запускает обновление при каждом запуске среды выполнения, если она поддерживает обновление.

Варианты:

  • false
  • true

description

string

Описание среды выполнения.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

desired_state

string

Требуемое состояние среды выполнения Colab.

Установите для этого поля значение `RUNNING`, чтобы запустить среду выполнения, и `STOPPED`, чтобы остановить ее.

Варианты:

  • "RUNNING" ← (по умолчанию)
  • "STOPPED"

display_name

string / обязательный

Отображаемое имя среды выполнения.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не уверены в своих действиях.

Это влияет только на строку User Agent для всех запросов API.

location

string / обязательный

Местоположение ресурса: https://cloud.google.com/colab/docs/locations.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

name

string / обязательный

Имя ресурса среды выполнения.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

notebook_runtime_template_ref

dictionary

«Информация о среде выполнения, используемая при создании NotebookRuntime».

notebook_runtime_template

string / обязательный

Имя ресурса NotebookRuntimeTemplate, на основе которого будет создан NotebookRuntime.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

project

string

Проект Google Cloud Platform, который следует использовать.

runtime_user

string / обязательный

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

scopes

list / elements=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.notebookRuntimes
  • Руководство по созданию среды выполнения: https://cloud.google.com/colab/docs/create-runtime
  • Для аутентификации можно задать 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
  google.cloud.gcp_colab_runtime:
    state: present
    name: my-runtime
    display_name: My Runtime
    runtime_user: my-user@gmail.com
    location: us-central1
    notebook_runtime_template_ref:
      notebook_runtime_template: my-runtime-template
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

- name: Create Basic Runtime in Stopped State
  google.cloud.gcp_colab_runtime:
    state: present
    name: my-runtime
    display_name: My Runtime
    location: us-central1
    runtime_user: my-user@gmail.com
    notebook_runtime_template_ref:
      notebook_runtime_template: my-runtime-template
    desired_state: STOPPED
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ

Описание

changed

boolean

Был ли изменен ресурс.

Возвращается: всегда

expirationTime

string

Только для вывода.

Временная метка истечения срока действия этого NotebookRuntime.

Возвращается: при успешном выполнении

isUpgradable

boolean

Только для вывода.

Проверяет, поддерживает ли NotebookRuntime обновление.

Возвращается: при успешном выполнении

notebookRuntimeType

string

Только для вывода.

Тип среды выполнения записной книжки.

Возвращается: при успешном выполнении

state

string

Только для вывода.

Состояние среды выполнения.

Возвращается: при успешном выполнении

Авторы

  • 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API