модуль google.cloud.gcp_colab_schedule — создание ресурса GCP Colab.Schedule

Примечание

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

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

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

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

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

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

«Расписания выполнения ноутбуков Colab Enterprise».

Требования

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

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

Параметры

Параметр	Описание
access_token string	Токен доступа для аутентификации.
allow_queueing boolean	Разрешает ли очередь запусков по расписанию, когда достигнут предел max_concurrent_runs. Если задано значение true, новые запуски будут добавляться в очередь, а не пропускаться. По умолчанию — false. Варианты: `false` `true`
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
create_notebook_execution_job_request dictionary / обязательный	Запрос для google_colab_notebook_execution. Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.
notebook_execution_job dictionary / обязательный	Создаваемый NotebookExecutionJob.
dataform_repository_source dictionary	Репозиторий Dataform, содержащий исходный ноутбук.
commit_sha string	SHA коммита, из которого следует прочитать репозиторий. Если значение не задано, файл будет прочитан из HEAD.
dataform_repository_resource_name string / обязательный	Имя ресурса репозитория Dataform.
display_name string / обязательный	Отображаемое имя выполнения ноутбука.
execution_timeout string	Максимальное время выполнения задания в секундах (по умолчанию 86400 с / 24 ч). Длительность в секундах с точностью до девяти знаков после запятой, оканчивающаяся на «s». Пример: «3.5s».
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. Формат: gs://bucket/notebook_file.ipynb.
gcs_output_uri string / обязательный	Расположение в Cloud Storage, куда следует загрузить результат. Формат: `gs://bucket-name`.
notebook_runtime_template_resource_name string / обязательный	NotebookRuntimeTemplate, из которого берется конфигурация вычислительных ресурсов.
service_account string	Сервисный аккаунт, от имени которого будет выполняться задание.
cron string / обязательный	Расписание Cron (https://en.wikipedia.org/wiki/Cron) для запуска заданий по расписанию.
desired_state string	Желаемое состояние расписания Colab. Задайте для этого поля значение `ACTIVE`, чтобы запустить или возобновить расписание, либо `PAUSED`, чтобы приостановить его. Варианты: `"ACTIVE"` ← (по умолчанию) `"PAUSED"`
display_name string / обязательный	Отображаемое имя расписания.
end_time string	Метка времени, после которой нельзя планировать новые запуски. Если указано это значение, расписание будет завершено, когда наступит end_time или когда scheduled_run_count >= max_run_count. Значение должно соответствовать формату RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt).
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Изменяется только строка User Agent для всех запросов API.
location string / обязательный	Регион ресурса: https://cloud.google.com/colab/docs/locations.
max_concurrent_run_count string / обязательный	Максимальное количество запусков этого расписания, которые могут выполняться одновременно. Это ограничение относится к запуску запланированных запросов, а не к выполнению заданий с ноутбуками, созданных этими запросами.
max_run_count string	Максимальное количество запусков по расписанию. Если значение указано, расписание будет завершено, когда startedRunCount >= maxRunCount или наступит endTime. Если значение не указано, новые запуски будут планироваться до тех пор, пока расписание не будет приостановлено или удалено. Уже запланированным запускам будет разрешено завершиться. Если значение не указано, параметр остается незаданным.
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / elements=string	Массив используемых областей доступа.
service_account_contents jsonarg	Содержимое JSON-файла сервисного аккаунта, представленное в виде словаря или JSON-строки.
service_account_email string	Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбран serviceaccount.
start_time string	Метка времени, после которой можно запланировать первый запуск. По умолчанию используется время создания расписания. Значение должно соответствовать формату RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt).
state string	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.schedules
Руководство по планированию запуска ноутбука: 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 Schedule
  google.cloud.gcp_colab_schedule:
    display_name: my-schedule
    state: present
    location: us-central1
    max_concurrent_run_count: 2
    cron: "TZ=America/Los_Angeles * * * * *"
    create_notebook_execution_job_request:
      notebook_execution_job:
        display_name: my-notebook-execution
        gcs_notebook_source:
          uri: gs://my-bucket/input/my-notebook.json
        notebook_runtime_template_resource_name: projects/my-project/locations/us-central1/notebookRuntimeTemplates/my-runtime-template
        gcs_output_uri: gs://my-bucket/output/
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

- name: Create Paused Schedule
  google.cloud.gcp_colab_schedule:
    display_name: my-schedule
    state: present
    location: us-central1
    desired_state: PAUSED
    max_concurrent_run_count: 2
    cron: "TZ=America/Los_Angeles * * * * *"
    create_notebook_execution_job_request:
      notebook_execution_job:
        display_name: my-notebook-execution
        gcs_notebook_source:
          uri: gs://my-bucket/input/my-notebook.json
        notebook_runtime_template_resource_name: projects/my-project/locations/us-central1/notebookRuntimeTemplates/my-runtime-template
        gcs_output_uri: gs://my-bucket/output/
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ	Описание
changed boolean	Был ли изменен ресурс. Возвращается: всегда
name 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_schedule_module.html