pulumi-gcp-kotlin/com.pulumi.gcp.clouddeploy.kotlin/Automation

Automation

class Automation : KotlinCustomResource

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement. To get more information about Automation, see:

Example Usage

Clouddeploy Automation Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const pipeline = new gcp.clouddeploy.DeliveryPipeline("pipeline", {
    name: "cd-pipeline",
    location: "us-central1",
    serialPipeline: {
        stages: [{
            targetId: "test",
            profiles: [],
        }],
    },
});
const b_automation = new gcp.clouddeploy.Automation("b-automation", {
    name: "cd-automation",
    project: pipeline.project,
    location: pipeline.location,
    deliveryPipeline: pipeline.name,
    serviceAccount: "my@service-account.com",
    selector: {
        targets: [{
            id: "*",
        }],
    },
    suspended: false,
    rules: [{
        promoteReleaseRule: {
            id: "promote-release",
        },
    }],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
pipeline = gcp.clouddeploy.DeliveryPipeline("pipeline",
    name="cd-pipeline",
    location="us-central1",
    serial_pipeline={
        "stages": [{
            "target_id": "test",
            "profiles": [],
        }],
    })
b_automation = gcp.clouddeploy.Automation("b-automation",
    name="cd-automation",
    project=pipeline.project,
    location=pipeline.location,
    delivery_pipeline=pipeline.name,
    service_account="my@service-account.com",
    selector={
        "targets": [{
            "id": "*",
        }],
    },
    suspended=False,
    rules=[{
        "promote_release_rule": {
            "id": "promote-release",
        },
    }])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var pipeline = new Gcp.CloudDeploy.DeliveryPipeline("pipeline", new()
    {
        Name = "cd-pipeline",
        Location = "us-central1",
        SerialPipeline = new Gcp.CloudDeploy.Inputs.DeliveryPipelineSerialPipelineArgs
        {
            Stages = new[]
            {
                new Gcp.CloudDeploy.Inputs.DeliveryPipelineSerialPipelineStageArgs
                {
                    TargetId = "test",
                    Profiles = new() { },
                },
            },
        },
    });
    var b_automation = new Gcp.CloudDeploy.Automation("b-automation", new()
    {
        Name = "cd-automation",
        Project = pipeline.Project,
        Location = pipeline.Location,
        DeliveryPipeline = pipeline.Name,
        ServiceAccount = "my@service-account.com",
        Selector = new Gcp.CloudDeploy.Inputs.AutomationSelectorArgs
        {
            Targets = new[]
            {
                new Gcp.CloudDeploy.Inputs.AutomationSelectorTargetArgs
                {
                    Id = "*",
                },
            },
        },
        Suspended = false,
        Rules = new[]
        {
            new Gcp.CloudDeploy.Inputs.AutomationRuleArgs
            {
                PromoteReleaseRule = new Gcp.CloudDeploy.Inputs.AutomationRulePromoteReleaseRuleArgs
                {
                    Id = "promote-release",
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/clouddeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pipeline, err := clouddeploy.NewDeliveryPipeline(ctx, "pipeline", &clouddeploy.DeliveryPipelineArgs{
			Name:     pulumi.String("cd-pipeline"),
			Location: pulumi.String("us-central1"),
			SerialPipeline: &clouddeploy.DeliveryPipelineSerialPipelineArgs{
				Stages: clouddeploy.DeliveryPipelineSerialPipelineStageArray{
					&clouddeploy.DeliveryPipelineSerialPipelineStageArgs{
						TargetId: pulumi.String("test"),
						Profiles: pulumi.StringArray{},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = clouddeploy.NewAutomation(ctx, "b-automation", &clouddeploy.AutomationArgs{
			Name:             pulumi.String("cd-automation"),
			Project:          pipeline.Project,
			Location:         pipeline.Location,
			DeliveryPipeline: pipeline.Name,
			ServiceAccount:   pulumi.String("my@service-account.com"),
			Selector: &clouddeploy.AutomationSelectorArgs{
				Targets: clouddeploy.AutomationSelectorTargetArray{
					&clouddeploy.AutomationSelectorTargetArgs{
						Id: pulumi.String("*"),
					},
				},
			},
			Suspended: pulumi.Bool(false),
			Rules: clouddeploy.AutomationRuleArray{
				&clouddeploy.AutomationRuleArgs{
					PromoteReleaseRule: &clouddeploy.AutomationRulePromoteReleaseRuleArgs{
						Id: pulumi.String("promote-release"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.clouddeploy.DeliveryPipeline;
import com.pulumi.gcp.clouddeploy.DeliveryPipelineArgs;
import com.pulumi.gcp.clouddeploy.inputs.DeliveryPipelineSerialPipelineArgs;
import com.pulumi.gcp.clouddeploy.Automation;
import com.pulumi.gcp.clouddeploy.AutomationArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationSelectorArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationRuleArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationRulePromoteReleaseRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var pipeline = new DeliveryPipeline("pipeline", DeliveryPipelineArgs.builder()
            .name("cd-pipeline")
            .location("us-central1")
            .serialPipeline(DeliveryPipelineSerialPipelineArgs.builder()
                .stages(DeliveryPipelineSerialPipelineStageArgs.builder()
                    .targetId("test")
                    .profiles()
                    .build())
                .build())
            .build());
        var b_automation = new Automation("b-automation", AutomationArgs.builder()
            .name("cd-automation")
            .project(pipeline.project())
            .location(pipeline.location())
            .deliveryPipeline(pipeline.name())
            .serviceAccount("my@service-account.com")
            .selector(AutomationSelectorArgs.builder()
                .targets(AutomationSelectorTargetArgs.builder()
                    .id("*")
                    .build())
                .build())
            .suspended(false)
            .rules(AutomationRuleArgs.builder()
                .promoteReleaseRule(AutomationRulePromoteReleaseRuleArgs.builder()
                    .id("promote-release")
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  b-automation:
    type: gcp:clouddeploy:Automation
    properties:
      name: cd-automation
      project: ${pipeline.project}
      location: ${pipeline.location}
      deliveryPipeline: ${pipeline.name}
      serviceAccount: my@service-account.com
      selector:
        targets:
          - id: '*'
      suspended: false
      rules:
        - promoteReleaseRule:
            id: promote-release
  pipeline:
    type: gcp:clouddeploy:DeliveryPipeline
    properties:
      name: cd-pipeline
      location: us-central1
      serialPipeline:
        stages:
          - targetId: test
            profiles: []
Content copied to clipboard

Clouddeploy Automation Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const pipeline = new gcp.clouddeploy.DeliveryPipeline("pipeline", {
    name: "cd-pipeline",
    location: "us-central1",
    serialPipeline: {
        stages: [{
            targetId: "test",
            profiles: ["test-profile"],
        }],
    },
});
const f_automation = new gcp.clouddeploy.Automation("f-automation", {
    name: "cd-automation",
    location: "us-central1",
    deliveryPipeline: pipeline.name,
    serviceAccount: "my@service-account.com",
    annotations: {
        my_first_annotation: "example-annotation-1",
        my_second_annotation: "example-annotation-2",
    },
    labels: {
        my_first_label: "example-label-1",
        my_second_label: "example-label-2",
    },
    description: "automation resource",
    selector: {
        targets: [{
            id: "test",
            labels: {
                foo: "bar",
            },
        }],
    },
    suspended: true,
    rules: [
        {
            promoteReleaseRule: {
                id: "promote-release",
                wait: "200s",
                destinationTargetId: "@next",
                destinationPhase: "stable",
            },
        },
        {
            advanceRolloutRule: {
                id: "advance-rollout",
                sourcePhases: ["deploy"],
                wait: "200s",
            },
        },
    ],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
pipeline = gcp.clouddeploy.DeliveryPipeline("pipeline",
    name="cd-pipeline",
    location="us-central1",
    serial_pipeline={
        "stages": [{
            "target_id": "test",
            "profiles": ["test-profile"],
        }],
    })
f_automation = gcp.clouddeploy.Automation("f-automation",
    name="cd-automation",
    location="us-central1",
    delivery_pipeline=pipeline.name,
    service_account="my@service-account.com",
    annotations={
        "my_first_annotation": "example-annotation-1",
        "my_second_annotation": "example-annotation-2",
    },
    labels={
        "my_first_label": "example-label-1",
        "my_second_label": "example-label-2",
    },
    description="automation resource",
    selector={
        "targets": [{
            "id": "test",
            "labels": {
                "foo": "bar",
            },
        }],
    },
    suspended=True,
    rules=[
        {
            "promote_release_rule": {
                "id": "promote-release",
                "wait": "200s",
                "destination_target_id": "@next",
                "destination_phase": "stable",
            },
        },
        {
            "advance_rollout_rule": {
                "id": "advance-rollout",
                "source_phases": ["deploy"],
                "wait": "200s",
            },
        },
    ])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var pipeline = new Gcp.CloudDeploy.DeliveryPipeline("pipeline", new()
    {
        Name = "cd-pipeline",
        Location = "us-central1",
        SerialPipeline = new Gcp.CloudDeploy.Inputs.DeliveryPipelineSerialPipelineArgs
        {
            Stages = new[]
            {
                new Gcp.CloudDeploy.Inputs.DeliveryPipelineSerialPipelineStageArgs
                {
                    TargetId = "test",
                    Profiles = new[]
                    {
                        "test-profile",
                    },
                },
            },
        },
    });
    var f_automation = new Gcp.CloudDeploy.Automation("f-automation", new()
    {
        Name = "cd-automation",
        Location = "us-central1",
        DeliveryPipeline = pipeline.Name,
        ServiceAccount = "my@service-account.com",
        Annotations =
        {
            { "my_first_annotation", "example-annotation-1" },
            { "my_second_annotation", "example-annotation-2" },
        },
        Labels =
        {
            { "my_first_label", "example-label-1" },
            { "my_second_label", "example-label-2" },
        },
        Description = "automation resource",
        Selector = new Gcp.CloudDeploy.Inputs.AutomationSelectorArgs
        {
            Targets = new[]
            {
                new Gcp.CloudDeploy.Inputs.AutomationSelectorTargetArgs
                {
                    Id = "test",
                    Labels =
                    {
                        { "foo", "bar" },
                    },
                },
            },
        },
        Suspended = true,
        Rules = new[]
        {
            new Gcp.CloudDeploy.Inputs.AutomationRuleArgs
            {
                PromoteReleaseRule = new Gcp.CloudDeploy.Inputs.AutomationRulePromoteReleaseRuleArgs
                {
                    Id = "promote-release",
                    Wait = "200s",
                    DestinationTargetId = "@next",
                    DestinationPhase = "stable",
                },
            },
            new Gcp.CloudDeploy.Inputs.AutomationRuleArgs
            {
                AdvanceRolloutRule = new Gcp.CloudDeploy.Inputs.AutomationRuleAdvanceRolloutRuleArgs
                {
                    Id = "advance-rollout",
                    SourcePhases = new[]
                    {
                        "deploy",
                    },
                    Wait = "200s",
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/clouddeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pipeline, err := clouddeploy.NewDeliveryPipeline(ctx, "pipeline", &clouddeploy.DeliveryPipelineArgs{
			Name:     pulumi.String("cd-pipeline"),
			Location: pulumi.String("us-central1"),
			SerialPipeline: &clouddeploy.DeliveryPipelineSerialPipelineArgs{
				Stages: clouddeploy.DeliveryPipelineSerialPipelineStageArray{
					&clouddeploy.DeliveryPipelineSerialPipelineStageArgs{
						TargetId: pulumi.String("test"),
						Profiles: pulumi.StringArray{
							pulumi.String("test-profile"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = clouddeploy.NewAutomation(ctx, "f-automation", &clouddeploy.AutomationArgs{
			Name:             pulumi.String("cd-automation"),
			Location:         pulumi.String("us-central1"),
			DeliveryPipeline: pipeline.Name,
			ServiceAccount:   pulumi.String("my@service-account.com"),
			Annotations: pulumi.StringMap{
				"my_first_annotation":  pulumi.String("example-annotation-1"),
				"my_second_annotation": pulumi.String("example-annotation-2"),
			},
			Labels: pulumi.StringMap{
				"my_first_label":  pulumi.String("example-label-1"),
				"my_second_label": pulumi.String("example-label-2"),
			},
			Description: pulumi.String("automation resource"),
			Selector: &clouddeploy.AutomationSelectorArgs{
				Targets: clouddeploy.AutomationSelectorTargetArray{
					&clouddeploy.AutomationSelectorTargetArgs{
						Id: pulumi.String("test"),
						Labels: pulumi.StringMap{
							"foo": pulumi.String("bar"),
						},
					},
				},
			},
			Suspended: pulumi.Bool(true),
			Rules: clouddeploy.AutomationRuleArray{
				&clouddeploy.AutomationRuleArgs{
					PromoteReleaseRule: &clouddeploy.AutomationRulePromoteReleaseRuleArgs{
						Id:                  pulumi.String("promote-release"),
						Wait:                pulumi.String("200s"),
						DestinationTargetId: pulumi.String("@next"),
						DestinationPhase:    pulumi.String("stable"),
					},
				},
				&clouddeploy.AutomationRuleArgs{
					AdvanceRolloutRule: &clouddeploy.AutomationRuleAdvanceRolloutRuleArgs{
						Id: pulumi.String("advance-rollout"),
						SourcePhases: pulumi.StringArray{
							pulumi.String("deploy"),
						},
						Wait: pulumi.String("200s"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.clouddeploy.DeliveryPipeline;
import com.pulumi.gcp.clouddeploy.DeliveryPipelineArgs;
import com.pulumi.gcp.clouddeploy.inputs.DeliveryPipelineSerialPipelineArgs;
import com.pulumi.gcp.clouddeploy.Automation;
import com.pulumi.gcp.clouddeploy.AutomationArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationSelectorArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationRuleArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationRulePromoteReleaseRuleArgs;
import com.pulumi.gcp.clouddeploy.inputs.AutomationRuleAdvanceRolloutRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var pipeline = new DeliveryPipeline("pipeline", DeliveryPipelineArgs.builder()
            .name("cd-pipeline")
            .location("us-central1")
            .serialPipeline(DeliveryPipelineSerialPipelineArgs.builder()
                .stages(DeliveryPipelineSerialPipelineStageArgs.builder()
                    .targetId("test")
                    .profiles("test-profile")
                    .build())
                .build())
            .build());
        var f_automation = new Automation("f-automation", AutomationArgs.builder()
            .name("cd-automation")
            .location("us-central1")
            .deliveryPipeline(pipeline.name())
            .serviceAccount("my@service-account.com")
            .annotations(Map.ofEntries(
                Map.entry("my_first_annotation", "example-annotation-1"),
                Map.entry("my_second_annotation", "example-annotation-2")
            ))
            .labels(Map.ofEntries(
                Map.entry("my_first_label", "example-label-1"),
                Map.entry("my_second_label", "example-label-2")
            ))
            .description("automation resource")
            .selector(AutomationSelectorArgs.builder()
                .targets(AutomationSelectorTargetArgs.builder()
                    .id("test")
                    .labels(Map.of("foo", "bar"))
                    .build())
                .build())
            .suspended(true)
            .rules(
                AutomationRuleArgs.builder()
                    .promoteReleaseRule(AutomationRulePromoteReleaseRuleArgs.builder()
                        .id("promote-release")
                        .wait("200s")
                        .destinationTargetId("@next")
                        .destinationPhase("stable")
                        .build())
                    .build(),
                AutomationRuleArgs.builder()
                    .advanceRolloutRule(AutomationRuleAdvanceRolloutRuleArgs.builder()
                        .id("advance-rollout")
                        .sourcePhases("deploy")
                        .wait("200s")
                        .build())
                    .build())
            .build());
    }
}
Content copied to clipboard
resources:
  f-automation:
    type: gcp:clouddeploy:Automation
    properties:
      name: cd-automation
      location: us-central1
      deliveryPipeline: ${pipeline.name}
      serviceAccount: my@service-account.com
      annotations:
        my_first_annotation: example-annotation-1
        my_second_annotation: example-annotation-2
      labels:
        my_first_label: example-label-1
        my_second_label: example-label-2
      description: automation resource
      selector:
        targets:
          - id: test
            labels:
              foo: bar
      suspended: true
      rules:
        - promoteReleaseRule:
            id: promote-release
            wait: 200s
            destinationTargetId: '@next'
            destinationPhase: stable
        - advanceRolloutRule:
            id: advance-rollout
            sourcePhases:
              - deploy
            wait: 200s
  pipeline:
    type: gcp:clouddeploy:DeliveryPipeline
    properties:
      name: cd-pipeline
      location: us-central1
      serialPipeline:
        stages:
          - targetId: test
            profiles:
              - test-profile
Content copied to clipboard

Import

Automation can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/deliveryPipelines/{{delivery_pipeline}}/automations/{{name}}

  • {{project}}/{{location}}/{{delivery_pipeline}}/{{name}}

  • {{location}}/{{delivery_pipeline}}/{{name}} When using the pulumi import command, Automation can be imported using one of the formats above. For example:

$ pulumi import gcp:clouddeploy/automation:Automation default projects/{{project}}/locations/{{location}}/deliveryPipelines/{{delivery_pipeline}}/automations/{{name}}
Content copied to clipboard
$ pulumi import gcp:clouddeploy/automation:Automation default {{project}}/{{location}}/{{delivery_pipeline}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:clouddeploy/automation:Automation default {{location}}/{{delivery_pipeline}}/{{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val annotations: Output<Map<String, String>>?

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash ('/'). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ('a-z0-9A-Z') with dashes ('-'), underscores ('_'), dots ('.'), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots('.'), not longer than 253 characters in total, followed by a slash ('/'). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.

Link copied to clipboard
val createTime: Output<String>

Output only. Time at which the automation was created.

Link copied to clipboard
val deliveryPipeline: Output<String>

The delivery_pipeline for the resource

Link copied to clipboard
val description: Output<String>?

Optional. Description of the 'Automation'. Max length is 255 characters.

Link copied to clipboard
Link copied to clipboard
val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Link copied to clipboard
val etag: Output<String>

Optional. The weak etag of the Automation resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val labels: Output<Map<String, String>>?

Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Link copied to clipboard
val location: Output<String>

The location for the resource

Link copied to clipboard
val name: Output<String>

Name of the Automation.

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val rules: Output<List<AutomationRule>>

Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution. Structure is documented below.

Link copied to clipboard
val selector: Output<AutomationSelector>

Required. Selected resources to which the automation will be applied. Structure is documented below.

Link copied to clipboard
val serviceAccount: Output<String>

Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.

Link copied to clipboard
val suspended: Output<Boolean>?

Optional. When Suspended, automation is deactivated from execution.

Link copied to clipboard
val uid: Output<String>

Output only. Unique identifier of the Automation.

Link copied to clipboard
val updateTime: Output<String>

Output only. Time at which the automation was updated.

Link copied to clipboard
val urn: Output<String>