Google Cloud Start

Google Cloud Start

Certified

Start a Compute Engine instance

Starts an existing, stopped Compute Engine instance and optionally waits for it to reach the RUNNING state.

yaml
type: io.kestra.plugin.gcp.compute.Start

Start an existing instance and log its IP.

yaml
id: compute_engine_start
namespace: company.team

tasks:
  - id: start_instance
    type: io.kestra.plugin.gcp.compute.Start
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_KEY') }}"
    projectId: "{{ secret('GCP_PROJECT_ID') }}"
    zone: "europe-west1-b"
    instanceName: "my-batch-vm"
    waitUntilRunning: "true"

  - id: log_status
    type: io.kestra.plugin.core.log.Log
    message: "Instance {{ outputs.start_instance.instanceName }} is {{ outputs.start_instance.status }} at {{ outputs.start_instance.externalIp }}"
Properties

The name of the Compute Engine instance

The zone where the instance is located

e.g. us-central1-a.

The GCP service account to impersonate

Reference (ref) of the pluginDefaults to apply to this task.

The GCP project ID

SubTypestring
Default["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used

The GCP service account

DefaultPT10M

The maximum duration to wait for the operation to complete

Default: PT10M. Hitting this timeout fails the task but does not cancel the in-flight GCP operation.

Defaulttrue

Whether to wait for the instance to reach the RUNNING state before completing the task

Default: true.

The instance's external (public) IP address, if any

Typically null once an instance is stopped, since ephemeral external IPs are released on stop.

The unique GCP instance ID

The name of the instance

The instance's internal (private) IP address

The instance status after the operation

e.g. PROVISIONING, STAGING, RUNNING, STOPPING, TERMINATED.