google.cloud.gcp_colab_runtime module – Creates a GCP Colab.Runtime resource

Note

This module is part of the google.cloud collection (version 1.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_colab_runtime.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

‘A runtime is a Google-provisioned virtual machine (VM) that can run the code in your notebook (IPYNB file).’

Requirements

The below requirements are needed on the host that executes this module.

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

Parameters

Parameter	Comments
access_token string	The access token used to authenticate.
auth_kind string / required	The type of credential used. Choices: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
auto_upgrade boolean	Triggers an upgrade anytime the runtime is started if it is upgradable. Choices: `false` `true`
description string	The description of the Runtime. This property is immutable, to change it, you must delete and recreate the resource.
desired_state string	Desired state of the Colab Runtime. Set this field to `RUNNING` to start the runtime, and `STOPPED` to stop it. Choices: `"RUNNING"` ← (default) `"STOPPED"`
display_name string / required	The display name of the Runtime. This property is immutable, to change it, you must delete and recreate the resource.
env_type string	Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests.
location string / required	The location for the resource: https://cloud.google.com/colab/docs/locations. This property is immutable, to change it, you must delete and recreate the resource.
name string / required	The resource name of the Runtime. This property is immutable, to change it, you must delete and recreate the resource.
notebook_runtime_template_ref dictionary	‘Runtime specific information used for NotebookRuntime creation.’.
notebook_runtime_template string / required	The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be created. This property is immutable, to change it, you must delete and recreate the resource.
project string	The Google Cloud Platform project to use.
runtime_user string / required	The user email of the NotebookRuntime. This property is immutable, to change it, you must delete and recreate the resource.
scopes list / elements=string	Array of scopes to be used.
service_account_contents jsonarg	The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email string	An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path	The path of a Service Account JSON file if serviceaccount is selected as type.
state string	Whether the resource should exist in GCP. Choices: `"present"` ← (default) `"absent"`

Notes

Note

API Reference: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes
Create a runtime Guide: https://cloud.google.com/colab/docs/create-runtime
For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
For authentication, you can set access_token using the GCP_ACCESS_TOKEN env variable.
For authentication, you can set scopes using the GCP_SCOPES env variable.
Environment variables values will only be used if the playbook values are not set.
The service_account_email, service_account_file, service_account_file and access_token options are mutually exclusive.

Examples

- 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 }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Whether the resource was changed. Returned: always
expirationTime string	Output only. Timestamp when this NotebookRuntime will be expired. Returned: success
isUpgradable boolean	Output only. Checks if the NotebookRuntime is upgradable. Returned: success
notebookRuntimeType string	Output only. The type of the notebook runtime. Returned: success
state string	Output only. The state of the runtime. Returned: success

Authors

Google Inc. (@googlecloudplatform)

Collection links

© 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