google.cloud.gcp_colab_runtime_template module – Creates a GCP Colab.RuntimeTemplate 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_template.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

‘A runtime template is a VM configuration that specifies a machine type and other characteristics of the VM,
as well as common settings such as the network and whether public internet access is enabled. When you create
a runtime, its VM is created according to the specifications of a runtime template.’

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"`
data_persistent_disk_spec dictionary	The configuration for the data disk of the runtime.
disk_size_gb string	The disk size of the runtime in GB. If specified, the diskType must also be specified. The minimum size is 10GB and the maximum is 65536GB.
disk_type string	The type of the persistent disk.
description string	The description of the Runtime Template.
display_name string / required	The display name of the Runtime Template.
encryption_spec dictionary	Customer-managed encryption key spec for the notebook runtime.
kms_key_name string	The Cloud KMS encryption key (customer-managed encryption key) used to protect the runtime.
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.
euc_config dictionary	EUC configuration of the NotebookRuntimeTemplate.
euc_disabled boolean	Disable end user credential access for the runtime. Choices: `false` `true`
idle_shutdown_config dictionary	Notebook Idle Shutdown configuration for the runtime.
idle_timeout string	The duration after which the runtime is automatically shut down. An input of 0s disables the idle shutdown feature, and a valid range is [10m, 24h].
labels dictionary	Labels to identify and group the runtime template.
location string / required	The location for the resource: https://cloud.google.com/colab/docs/locations.
machine_spec dictionary	‘The machine configuration of the runtime.’.
accelerator_count integer	The number of accelerators used by the runtime.
accelerator_type string	The type of hardware accelerator used by the runtime. If specified, acceleratorCount must also be specified.
machine_type string	The Compute Engine machine type selected for the runtime.
name string / required	The resource name of the Runtime Template.
network_spec dictionary	The network configuration for the runtime.
enable_internet_access boolean	Enable public internet access for the runtime. Choices: `false` `true`
network string	The name of the VPC that this runtime is in.
subnetwork string	The name of the subnetwork that this runtime is in.
network_tags list / elements=string	Applies the given Compute Engine tags to the runtime.
project string	The Google Cloud Platform project to use.
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.
shielded_vm_config dictionary	Runtime Shielded VM spec.
enable_secure_boot boolean	Enables secure boot for the runtime. Choices: `false` `true`
software_config dictionary	The notebook software configuration of the notebook runtime.
env list / elements=dictionary	Environment variables to be passed to the container.
name string	Name of the environment variable. Must be a valid C identifier.
value string	Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
post_startup_script_config dictionary	Post startup script config.
post_startup_script string	Post startup script to run after runtime is started.
post_startup_script_behavior string	Post startup script behavior that defines download and execution behavior. Choices: `"RUN_ONCE"` `"RUN_EVERY_START"` `"DOWNLOAD_AND_RUN_EVERY_START"`
post_startup_script_url string	Post startup script url to download. Example: https://bucket/script.sh.
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.notebookRuntimeTemplates
Create a runtime template Guide: https://cloud.google.com/colab/docs/create-runtime-template
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 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 }}"

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
state string	The current state of the resource. Returned: always

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