Google Compute Engine Stop

Google Compute Engine Stop

Certified

Stop a Compute Engine instance

Stops a running Compute Engine instance and optionally waits for it to reach the TERMINATED state. The instance's disks and configuration are preserved.

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

Create a VM instance and then stop it.

yaml
id: compute_engine_create
namespace: company.team

tasks:
  - id: create_instance
    type: io.kestra.plugin.gcp.compute.Create
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_KEY') }}"
    projectId: "{{ secret('GCP_PROJECT_ID') }}"
    zone: "us-central1-a"
    instanceName: "kestra-job-{{ execution.id }}"
    machineType: "n1-standard-2"
    sourceImage: "projects/debian-cloud/global/images/family/debian-11"
    startupScript: "apt-get update && apt-get install -y python3"
    waitUntilRunning: "true"

  - id: stop_instance
    type: io.kestra.plugin.gcp.compute.Stop
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_KEY') }}"
    projectId: "{{ secret('GCP_PROJECT_ID') }}"
    zone: "us-central1-a"
    instanceName: "{{ outputs.create_instance.instanceName }}"
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-gcp --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

The name of the Compute Engine instance

The zone where the instance is located

e.g. us-central1-a.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

The GCP service account to impersonate

The GCP project ID

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

The GCP scopes to be used

The GCP service account

When unset or rendered to an empty value, Application Default Credentials are used (e.g. GOOGLE_APPLICATION_CREDENTIALS or the runtime's attached identity).

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 TERMINATED state before completing the task

Default: true.

Audience of the Workload Identity Federation provider

The full resource name of the workload identity pool provider, //iam.googleapis.com/projects/<number>/locations/global/workloadIdentityPools/<pool>/providers/<provider>. Required with workloadIdentityToken, and must match the aud claim of the token.

OIDC token for Workload Identity Federation

When set together with workloadIdentityAudience, the token is exchanged at Google STS for federated credentials and no service account key is needed: Google verifies it against the identity provider that issued it. Use {{ oidcToken(audience='…') }} to have Kestra Enterprise mint one for the running execution. Combine with impersonatedServiceAccount to act as a service account the pool may impersonate, and set projectId explicitly since no key file carries it. Cannot be combined with serviceAccount.

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.