pulumi-gcp-kotlin/com.pulumi.gcp.cloudrunv2.kotlin/Job

Job

A Cloud Run Job resource that references a container image which is run to completion. To get more information about Job, see:

API documentation
How-to Guides

Official Documentation

Example Usage

Cloudrunv2 Job Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudrunv2.Job;
import com.pulumi.gcp.cloudrunv2.JobArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateTemplateArgs;
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 default_ = new Job("default", JobArgs.builder()
            .launchStage("BETA")
            .location("us-central1")
            .template(JobTemplateArgs.builder()
                .template(JobTemplateTemplateArgs.builder()
                    .containers(JobTemplateTemplateContainerArgs.builder()
                        .image("us-docker.pkg.dev/cloudrun/container/hello")
                        .build())
                    .build())
                .build())
            .build());
    }
}

Cloudrunv2 Job Sql

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.secretmanager.Secret;
import com.pulumi.gcp.secretmanager.SecretArgs;
import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
import com.pulumi.gcp.sql.DatabaseInstance;
import com.pulumi.gcp.sql.DatabaseInstanceArgs;
import com.pulumi.gcp.sql.inputs.DatabaseInstanceSettingsArgs;
import com.pulumi.gcp.cloudrunv2.Job;
import com.pulumi.gcp.cloudrunv2.JobArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateTemplateArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.secretmanager.SecretVersion;
import com.pulumi.gcp.secretmanager.SecretVersionArgs;
import com.pulumi.gcp.secretmanager.SecretIamMember;
import com.pulumi.gcp.secretmanager.SecretIamMemberArgs;
import com.pulumi.resources.CustomResourceOptions;
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 secret = new Secret("secret", SecretArgs.builder()
            .secretId("secret")
            .replication(SecretReplicationArgs.builder()
                .automatic(true)
                .build())
            .build());
        var instance = new DatabaseInstance("instance", DatabaseInstanceArgs.builder()
            .region("us-central1")
            .databaseVersion("MYSQL_5_7")
            .settings(DatabaseInstanceSettingsArgs.builder()
                .tier("db-f1-micro")
                .build())
            .deletionProtection("true")
            .build());
        var default_ = new Job("default", JobArgs.builder()
            .location("us-central1")
            .launchStage("BETA")
            .template(JobTemplateArgs.builder()
                .template(JobTemplateTemplateArgs.builder()
                    .volumes(JobTemplateTemplateVolumeArgs.builder()
                        .name("cloudsql")
                        .cloudSqlInstance(JobTemplateTemplateVolumeCloudSqlInstanceArgs.builder()
                            .instances(instance.connectionName())
                            .build())
                        .build())
                    .containers(JobTemplateTemplateContainerArgs.builder()
                        .image("us-docker.pkg.dev/cloudrun/container/hello")
                        .envs(
                            JobTemplateTemplateContainerEnvArgs.builder()
                                .name("FOO")
                                .value("bar")
                                .build(),
                            JobTemplateTemplateContainerEnvArgs.builder()
                                .name("latestdclsecret")
                                .valueSource(JobTemplateTemplateContainerEnvValueSourceArgs.builder()
                                    .secretKeyRef(JobTemplateTemplateContainerEnvValueSourceSecretKeyRefArgs.builder()
                                        .secret(secret.secretId())
                                        .version("1")
                                        .build())
                                    .build())
                                .build())
                        .volumeMounts(JobTemplateTemplateContainerVolumeMountArgs.builder()
                            .name("cloudsql")
                            .mountPath("/cloudsql")
                            .build())
                        .build())
                    .build())
                .build())
            .build());
        final var project = OrganizationsFunctions.getProject();
        var secret_version_data = new SecretVersion("secret-version-data", SecretVersionArgs.builder()
            .secret(secret.name())
            .secretData("secret-data")
            .build());
        var secret_access = new SecretIamMember("secret-access", SecretIamMemberArgs.builder()
            .secretId(secret.id())
            .role("roles/secretmanager.secretAccessor")
            .member(String.format("serviceAccount:%s-compute@developer.gserviceaccount.com", project.applyValue(getProjectResult -> getProjectResult.number())))
            .build(), CustomResourceOptions.builder()
                .dependsOn(secret)
                .build());
    }
}

Cloudrunv2 Job Vpcaccess

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.vpcaccess.Connector;
import com.pulumi.gcp.vpcaccess.ConnectorArgs;
import com.pulumi.gcp.vpcaccess.inputs.ConnectorSubnetArgs;
import com.pulumi.gcp.cloudrunv2.Job;
import com.pulumi.gcp.cloudrunv2.JobArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateTemplateArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateTemplateVpcAccessArgs;
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 customTestNetwork = new Network("customTestNetwork", NetworkArgs.builder()
            .autoCreateSubnetworks(false)
            .build());
        var customTestSubnetwork = new Subnetwork("customTestSubnetwork", SubnetworkArgs.builder()
            .ipCidrRange("10.2.0.0/28")
            .region("us-central1")
            .network(customTestNetwork.id())
            .build());
        var connector = new Connector("connector", ConnectorArgs.builder()
            .subnet(ConnectorSubnetArgs.builder()
                .name(customTestSubnetwork.name())
                .build())
            .machineType("e2-standard-4")
            .minInstances(2)
            .maxInstances(3)
            .region("us-central1")
            .build());
        var default_ = new Job("default", JobArgs.builder()
            .location("us-central1")
            .launchStage("BETA")
            .template(JobTemplateArgs.builder()
                .template(JobTemplateTemplateArgs.builder()
                    .containers(JobTemplateTemplateContainerArgs.builder()
                        .image("us-docker.pkg.dev/cloudrun/container/hello")
                        .build())
                    .vpcAccess(JobTemplateTemplateVpcAccessArgs.builder()
                        .connector(connector.id())
                        .egress("ALL_TRAFFIC")
                        .build())
                    .build())
                .build())
            .build());
    }
}

Cloudrunv2 Job Secret

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.secretmanager.Secret;
import com.pulumi.gcp.secretmanager.SecretArgs;
import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
import com.pulumi.gcp.cloudrunv2.Job;
import com.pulumi.gcp.cloudrunv2.JobArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateArgs;
import com.pulumi.gcp.cloudrunv2.inputs.JobTemplateTemplateArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.secretmanager.SecretVersion;
import com.pulumi.gcp.secretmanager.SecretVersionArgs;
import com.pulumi.gcp.secretmanager.SecretIamMember;
import com.pulumi.gcp.secretmanager.SecretIamMemberArgs;
import com.pulumi.resources.CustomResourceOptions;
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 secret = new Secret("secret", SecretArgs.builder()
            .secretId("secret")
            .replication(SecretReplicationArgs.builder()
                .automatic(true)
                .build())
            .build());
        var default_ = new Job("default", JobArgs.builder()
            .location("us-central1")
            .launchStage("BETA")
            .template(JobTemplateArgs.builder()
                .template(JobTemplateTemplateArgs.builder()
                    .volumes(JobTemplateTemplateVolumeArgs.builder()
                        .name("a-volume")
                        .secret(JobTemplateTemplateVolumeSecretArgs.builder()
                            .secret(secret.secretId())
                            .defaultMode(292)
                            .items(JobTemplateTemplateVolumeSecretItemArgs.builder()
                                .version("1")
                                .path("my-secret")
                                .mode(256)
                                .build())
                            .build())
                        .build())
                    .containers(JobTemplateTemplateContainerArgs.builder()
                        .image("us-docker.pkg.dev/cloudrun/container/hello")
                        .volumeMounts(JobTemplateTemplateContainerVolumeMountArgs.builder()
                            .name("a-volume")
                            .mountPath("/secrets")
                            .build())
                        .build())
                    .build())
                .build())
            .build());
        final var project = OrganizationsFunctions.getProject();
        var secret_version_data = new SecretVersion("secret-version-data", SecretVersionArgs.builder()
            .secret(secret.name())
            .secretData("secret-data")
            .build());
        var secret_access = new SecretIamMember("secret-access", SecretIamMemberArgs.builder()
            .secretId(secret.id())
            .role("roles/secretmanager.secretAccessor")
            .member(String.format("serviceAccount:%s-compute@developer.gserviceaccount.com", project.applyValue(getProjectResult -> getProjectResult.number())))
            .build(), CustomResourceOptions.builder()
                .dependsOn(secret)
                .build());
    }
}

Import

Job can be imported using any of these accepted formats

$ pulumi import gcp:cloudrunv2/job:Job default projects/{{project}}/locations/{{location}}/jobs/{{name}}

$ pulumi import gcp:cloudrunv2/job:Job default {{project}}/{{location}}/{{name}}

$ pulumi import gcp:cloudrunv2/job:Job default {{location}}/{{name}}

Properties

binaryAuthorization

val binaryAuthorization: Output<JobBinaryAuthorization>?

Settings for the Binary Authorization feature. Structure is documented below.

client

val client: Output<String>?

Arbitrary identifier for the API client.

clientVersion

val clientVersion: Output<String>?

Arbitrary version identifier for the API client.

conditions

val conditions: Output<List<JobCondition>>

The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run. Structure is documented below.

etag

val etag: Output<String>

A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

executionCount

val executionCount: Output<Int>

Number of executions created for this job.

generation

val generation: Output<String>

A number that monotonically increases every time the user modifies the desired state.

val id: Output<String>

labels

val labels: Output<Map<String, String>>?

KRM-style labels for the resource. (Optional) KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.

latestCreatedExecutions

val latestCreatedExecutions: Output<List<JobLatestCreatedExecution>>

Name of the last created execution. Structure is documented below.

launchStage

val launchStage: Output<String>

The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values are UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, and DEPRECATED.

location

val location: Output<String>?

The location of the cloud run job

name

val name: Output<String>

Name of the Job.

observedGeneration

val observedGeneration: Output<String>

The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

reconciling

val reconciling: Output<Boolean>

Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observedGeneration and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: observedGeneration and generation, latest_succeeded_execution and latestCreatedExecution. If reconciliation failed, observedGeneration and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminalCondition and conditions

template

val template: Output<JobTemplate>

The template used to create executions for this Job. Structure is documented below.

terminalConditions

val terminalConditions: Output<List<JobTerminalCondition>>

The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state Structure is documented below.

uid

val uid: Output<String>

Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

urn

val urn: Output<String>