google.cloud.gcp_colab_runtime_template module – Manages a Colab.RuntimeTemplate resource

Note

This module is part of the google.cloud collection (version 1.15.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

  • ‘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.

This property is immutable, to change it, you must delete and recreate the resource.

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.

This property is immutable, to change it, you must delete and recreate the resource.

disk_type

string

The type of the persistent disk.

This property is immutable, to change it, you must delete and recreate the resource.

description

string

The description of the Runtime Template.

This property is immutable, to change it, you must delete and recreate the resource.

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.

This property is immutable, to change it, you must delete and recreate the resource.

euc_disabled

boolean

Disable end user credential access for the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

Choices:

  • false

  • true

idle_shutdown_config

dictionary

Notebook Idle Shutdown configuration for the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

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.

**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.

location

string / required

The location for the resource: https://cloud.google.com/colab/docs/locations.

machine_spec

dictionary

‘The machine configuration of the runtime.’.

This property is immutable, to change it, you must delete and recreate the resource.

accelerator_count

integer

The number of accelerators used by the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

accelerator_type

string

The type of hardware accelerator used by the runtime.

If specified, acceleratorCount must also be specified.

This property is immutable, to change it, you must delete and recreate the resource.

machine_type

string

The Compute Engine machine type selected for the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

name

string / required

The resource name of the Runtime Template.

This property is immutable, to change it, you must delete and recreate the resource.

network_spec

dictionary

The network configuration for the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

enable_internet_access

boolean

Enable public internet access for the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

Choices:

  • false

  • true

network

string

The name of the VPC that this runtime is in.

This property is immutable, to change it, you must delete and recreate the resource.

subnetwork

string

The name of the subnetwork that this runtime is in.

This property is immutable, to change it, you must delete and recreate the resource.

network_tags

list / elements=string

Applies the given Compute Engine tags to the runtime.

This property is immutable, to change it, you must delete and recreate the resource.

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.

This property is immutable, to change it, you must delete and recreate the resource.

enable_secure_boot

boolean

Enables secure boot for the runtime.

Choices:

  • false

  • true

software_config

dictionary

The notebook software configuration of the notebook runtime.

colab_image

dictionary

Colab Image Configuration.

release_name

string

The release name of the NotebookRuntime Colab image, e.g.

“py310”.

If not specified, detault to the latest release.

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.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

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

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)