модуль google.cloud.gcp_colab_notebook_execution — создание ресурса GCP Colab.NotebookExecution
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем также требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_colab_notebook_execution.
Краткое описание
- «Экземпляр выполнения ноутбука»
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 3.8
- requests >= 2.18.4
- google-auth >= 2.25.1
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа, используемый для аутентификации. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
custom_environment_spec dictionary | Конфигурация вычислительных ресурсов для задания выполнения. |
|
machine_spec dictionary |
«Конфигурация машины среды выполнения». |
|
accelerator_count integer |
Количество ускорителей, используемых средой выполнения. |
|
accelerator_type string |
Тип аппаратного ускорителя, используемого средой выполнения. Если параметр указан, необходимо также указать acceleratorCount. |
|
machine_type string |
Тип машины Compute Engine, выбранный для среды выполнения. |
|
network_spec dictionary |
Конфигурация сети для среды выполнения. |
|
enable_internet_access boolean |
Разрешить среде выполнения доступ к общедоступному интернету. Варианты:
|
|
network string |
Имя сети VPC, в которой находится среда выполнения. |
|
subnetwork string |
Имя подсети, в которой находится среда выполнения. |
|
persistent_disk_spec dictionary |
Конфигурация диска данных среды выполнения. |
|
disk_size_gb string |
Размер диска среды выполнения в ГБ. Если параметр указан, необходимо также указать diskType. Минимальный размер — 10 ГБ, максимальный — 65536 ГБ. |
|
disk_type string |
Тип постоянного диска. |
dataform_repository_source dictionary | Репозиторий Dataform, содержащий входной ноутбук. |
|
commit_sha string |
SHA коммита, который используется для чтения репозитория. Если параметр не задан, файл будет прочитан из HEAD. |
|
dataform_repository_resource_name string / обязательный |
Имя ресурса репозитория Dataform. |
direct_notebook_source dictionary | Содержимое входного ноутбука в формате ipynb. |
|
content string / обязательный |
Содержимое файла входного ноутбука в кодировке base64. |
display_name string / обязательный | Отображаемое имя выполнения ноутбука. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов к API. |
execution_timeout string | Максимальное время выполнения задания в секундах (по умолчанию — 86400 с / 24 ч). |
execution_user string | Адрес электронной почты пользователя, от имени которого будет выполняться задание. |
gcs_notebook_source dictionary | URI Cloud Storage входного ноутбука. |
|
generation string |
Версия объекта Cloud Storage, которую нужно прочитать. Если параметр не задан, будет прочитана текущая версия объекта. См. https://cloud.google.com/storage/docs/metadata#generation-number. |
|
uri string / обязательный |
URI Cloud Storage, указывающий на файл ipynb. |
gcs_output_uri string / обязательный | Расположение в Cloud Storage, куда нужно загрузить результат. Формат: `gs://bucket-name`. |
location string / обязательный | Расположение ресурса: https://cloud.google.com/colab/docs/locations. |
notebook_execution_job_id string | Идентификатор задания выполнения ноутбука, указанный пользователем. |
notebook_runtime_template_resource_name string | Шаблон NotebookRuntimeTemplate, из которого берется конфигурация вычислительных ресурсов. |
project string | Проект Google Cloud Platform, который нужно использовать. |
scopes list / элементы=string | Массив областей доступа, которые будут использоваться. |
service_account string | Сервисный аккаунт, от имени которого будет выполняться задание. |
service_account_contents jsonarg | Содержимое JSON-файла сервисного аккаунта, представленное в виде словаря или строки JSON. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу сервисного аккаунта, если выбран тип serviceaccount. |
state string | Должен ли ресурс существовать в GCP. Варианты:
|
Примечания
Примечание
- Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs
- Руководство по планированию запуска ноутбука: https://cloud.google.com/colab/docs/schedule-notebook-run
- Для аутентификации можно задать 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 Notebook Execution
vars:
nb_config:
cells:
- cell_type: code
execution_count: null
metadata: {}
outputs: []
source:
- print('Hello, World!')
metadata:
kernelspec:
display_name: Python 3
language: python
name: python3
language_info:
codemirror_mode:
name: ipython
version: 3
file_extension: .py
mimetype: text/x-python
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
version: 3.8.5
nbformat: 4
nbformat_minor: 4
google.cloud.gcp_colab_notebook_execution:
state: present
display_name: my-notebook-execution
location: us-central1
direct_notebook_source:
content: "{{ nb_config | to_json | b64encode }}"
notebook_runtime_template_resource_name: projects/{{ gcp_project }}/locations/us-central1/notebookRuntimeTemplates/my-runtime-template
gcs_output_uri: gs://my-bucket
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
################################################################################
- name: Create Notebook Execution With Custom Environment
vars:
nb_config:
cells:
- cell_type: code
execution_count: null
metadata: {}
outputs: []
source:
- print('Hello, World!')
metadata:
kernelspec:
display_name: Python 3
language: python
name: python3
language_info:
codemirror_mode:
name: ipython
version: 3
file_extension: .py
mimetype: text/x-python
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
version: 3.8.5
nbformat: 4
nbformat_minor: 4
google.cloud.gcp_colab_notebook_execution:
state: present
display_name: my-notebook-execution
location: us-central1
direct_notebook_source:
content: "{{ nb_config | to_json | b64encode }}"
notebook_runtime_template_resource_name: projects/{{ gcp_project }}/locations/us-central1/notebookRuntimeTemplates/my-runtime-template
custom_environment_spec:
machine_spec:
machine_type: n1-standard-4
accelerator_type: NVIDIA_TESLA_T4
accelerator_count: 1
persistent_disk_spec:
disk_type: pd-standard
disk_size_gb: 100
network_spec:
enable_internet_access: true
network: "projects/{{ gcp_project }}/global/networks/my-network"
gcs_output_uri: gs://my-bucket
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
################################################################################
- name: Create Notebook Execution With Dataform Repository Source
google.cloud.gcp_colab_notebook_execution:
state: present
display_name: my-notebook-execution
location: us-central1
dataform_repository_source:
commit_sha: deadbeef
dataform_repository_resource_name: projects/{{ gcp_project }}/locations/us-central1/dataform/repositories/my-dataform-repository
notebook_runtime_template_resource_name: projects/{{ gcp_project }}/locations/us-central1/notebookRuntimeTemplates/my-runtime-template
gcs_output_uri: gs://my-bucket
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Был ли изменен ресурс. Возвращается: всегда |
state string | Текущее состояние ресурса. Возвращается: всегда |
Ссылки на коллекцию
© 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_notebook_execution_module.html