@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
718 lines • 26.7 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Service = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
*
* To get more information about Service, see:
*
* * [API documentation](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/run/docs/)
*
* ## Example Usage
*
* ### Cloudrunv2 Service Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Limits
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* resources: {
* limits: {
* cpu: "2",
* memory: "1024Mi",
* },
* },
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Sql
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const secret = new gcp.secretmanager.Secret("secret", {
* secretId: "secret-1",
* replication: {
* auto: {},
* },
* });
* const secret_version_data = new gcp.secretmanager.SecretVersion("secret-version-data", {
* secret: secret.name,
* secretData: "secret-data",
* });
* const instance = new gcp.sql.DatabaseInstance("instance", {
* name: "cloudrun-sql",
* region: "us-central1",
* databaseVersion: "MYSQL_5_7",
* settings: {
* tier: "db-f1-micro",
* },
* deletionProtection: true,
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* scaling: {
* maxInstanceCount: 2,
* },
* volumes: [{
* name: "cloudsql",
* cloudSqlInstance: {
* instances: [instance.connectionName],
* },
* }],
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* envs: [
* {
* name: "FOO",
* value: "bar",
* },
* {
* name: "SECRET_ENV_VAR",
* valueSource: {
* secretKeyRef: {
* secret: secret.secretId,
* version: "1",
* },
* },
* },
* ],
* volumeMounts: [{
* name: "cloudsql",
* mountPath: "/cloudsql",
* }],
* }],
* },
* traffics: [{
* type: "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST",
* percent: 100,
* }],
* }, {
* dependsOn: [secret_version_data],
* });
* const project = gcp.organizations.getProject({});
* const secret_access = new gcp.secretmanager.SecretIamMember("secret-access", {
* secretId: secret.id,
* role: "roles/secretmanager.secretAccessor",
* member: project.then(project => `serviceAccount:${project.number}-compute@developer.gserviceaccount.com`),
* }, {
* dependsOn: [secret],
* });
* ```
* ### Cloudrunv2 Service Vpcaccess
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const customTestNetwork = new gcp.compute.Network("custom_test", {
* name: "run-network",
* autoCreateSubnetworks: false,
* });
* const customTest = new gcp.compute.Subnetwork("custom_test", {
* name: "run-subnetwork",
* ipCidrRange: "10.2.0.0/28",
* region: "us-central1",
* network: customTestNetwork.id,
* });
* const connector = new gcp.vpcaccess.Connector("connector", {
* name: "run-vpc",
* subnet: {
* name: customTest.name,
* },
* machineType: "e2-standard-4",
* minInstances: 2,
* maxInstances: 3,
* region: "us-central1",
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* }],
* vpcAccess: {
* connector: connector.id,
* egress: "ALL_TRAFFIC",
* },
* },
* });
* ```
* ### Cloudrunv2 Service Directvpc
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* launchStage: "GA",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* }],
* vpcAccess: {
* networkInterfaces: [{
* network: "default",
* subnetwork: "default",
* tags: [
* "tag1",
* "tag2",
* "tag3",
* ],
* }],
* },
* },
* });
* ```
* ### Cloudrunv2 Service Gpu
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* launchStage: "BETA",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* resources: {
* limits: {
* cpu: "4",
* memory: "16Gi",
* "nvidia.com/gpu": "1",
* },
* startupCpuBoost: true,
* },
* }],
* nodeSelector: {
* accelerator: "nvidia-l4",
* },
* scaling: {
* maxInstanceCount: 1,
* },
* },
* });
* ```
* ### Cloudrunv2 Service Probes
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* startupProbe: {
* initialDelaySeconds: 0,
* timeoutSeconds: 1,
* periodSeconds: 3,
* failureThreshold: 1,
* tcpSocket: {
* port: 8080,
* },
* },
* livenessProbe: {
* httpGet: {
* path: "/",
* },
* },
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Secret
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const secret = new gcp.secretmanager.Secret("secret", {
* secretId: "secret-1",
* replication: {
* auto: {},
* },
* });
* const secret_version_data = new gcp.secretmanager.SecretVersion("secret-version-data", {
* secret: secret.name,
* secretData: "secret-data",
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* volumes: [{
* name: "a-volume",
* secret: {
* secret: secret.secretId,
* defaultMode: 292,
* items: [{
* version: "1",
* path: "my-secret",
* }],
* },
* }],
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* volumeMounts: [{
* name: "a-volume",
* mountPath: "/secrets",
* }],
* }],
* },
* }, {
* dependsOn: [secret_version_data],
* });
* const project = gcp.organizations.getProject({});
* const secret_access = new gcp.secretmanager.SecretIamMember("secret-access", {
* secretId: secret.id,
* role: "roles/secretmanager.secretAccessor",
* member: project.then(project => `serviceAccount:${project.number}-compute@developer.gserviceaccount.com`),
* }, {
* dependsOn: [secret],
* });
* ```
* ### Cloudrunv2 Service Multicontainer
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* containers: [
* {
* name: "hello-1",
* ports: {
* containerPort: 8080,
* },
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* dependsOns: ["hello-2"],
* volumeMounts: [{
* name: "empty-dir-volume",
* mountPath: "/mnt",
* }],
* },
* {
* name: "hello-2",
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* envs: [{
* name: "PORT",
* value: "8081",
* }],
* startupProbe: {
* httpGet: {
* port: 8081,
* },
* },
* },
* ],
* volumes: [{
* name: "empty-dir-volume",
* emptyDir: {
* medium: "MEMORY",
* sizeLimit: "256Mi",
* },
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Mount Gcs
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultBucket = new gcp.storage.Bucket("default", {
* name: "cloudrun-service",
* location: "US",
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* template: {
* executionEnvironment: "EXECUTION_ENVIRONMENT_GEN2",
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* volumeMounts: [{
* name: "bucket",
* mountPath: "/var/www",
* }],
* }],
* volumes: [{
* name: "bucket",
* gcs: {
* bucket: defaultBucket.name,
* readOnly: false,
* },
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Mount Nfs
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultInstance = new gcp.filestore.Instance("default", {
* name: "cloudrun-service",
* location: "us-central1-b",
* tier: "BASIC_HDD",
* fileShares: {
* capacityGb: 1024,
* name: "share1",
* },
* networks: [{
* network: "default",
* modes: ["MODE_IPV4"],
* }],
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* executionEnvironment: "EXECUTION_ENVIRONMENT_GEN2",
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello:latest",
* volumeMounts: [{
* name: "nfs",
* mountPath: "/mnt/nfs/filestore",
* }],
* }],
* vpcAccess: {
* networkInterfaces: [{
* network: "default",
* subnetwork: "default",
* }],
* },
* volumes: [{
* name: "nfs",
* nfs: {
* server: defaultInstance.networks.apply(networks => networks[0].ipAddresses?.[0]),
* path: "/share1",
* readOnly: false,
* },
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Mesh
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumi/time";
*
* const mesh = new gcp.networkservices.Mesh("mesh", {name: "network-services-mesh"});
* const waitForMesh = new time.index.Sleep("wait_for_mesh", {createDuration: "1m"}, {
* dependsOn: [mesh],
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* deletionProtection: false,
* location: "us-central1",
* launchStage: "BETA",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* }],
* serviceMesh: {
* mesh: mesh.id,
* },
* },
* }, {
* dependsOn: [waitForMesh],
* });
* ```
* ### Cloudrunv2 Service Invokeriam
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* invokerIamDisabled: true,
* description: "The serving URL of this service will not perform any IAM check when invoked",
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* }],
* },
* });
* ```
* ### Cloudrunv2 Service Function
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const bucket = new gcp.storage.Bucket("bucket", {
* name: project.then(project => `${project.projectId}-gcf-source`),
* location: "US",
* uniformBucketLevelAccess: true,
* });
* const object = new gcp.storage.BucketObject("object", {
* name: "function-source.zip",
* bucket: bucket.name,
* source: new pulumi.asset.FileAsset("function_source.zip"),
* });
* const cloudbuildServiceAccount = new gcp.serviceaccount.Account("cloudbuild_service_account", {accountId: "build-sa"});
* const actAs = new gcp.projects.IAMMember("act_as", {
* project: project.then(project => project.projectId),
* role: "roles/iam.serviceAccountUser",
* member: pulumi.interpolate`serviceAccount:${cloudbuildServiceAccount.email}`,
* });
* const logsWriter = new gcp.projects.IAMMember("logs_writer", {
* project: project.then(project => project.projectId),
* role: "roles/logging.logWriter",
* member: pulumi.interpolate`serviceAccount:${cloudbuildServiceAccount.email}`,
* });
* const _default = new gcp.cloudrunv2.Service("default", {
* name: "cloudrun-service",
* location: "us-central1",
* deletionProtection: false,
* ingress: "INGRESS_TRAFFIC_ALL",
* template: {
* containers: [{
* image: "us-docker.pkg.dev/cloudrun/container/hello",
* baseImageUri: "us-central1-docker.pkg.dev/serverless-runtimes/google-22-full/runtimes/nodejs22",
* }],
* },
* buildConfig: {
* sourceLocation: pulumi.interpolate`gs://${bucket.name}/${object.name}`,
* functionTarget: "helloHttp",
* imageUri: "us-docker.pkg.dev/cloudrun/container/hello",
* baseImage: "us-central1-docker.pkg.dev/serverless-runtimes/google-22-full/runtimes/nodejs22",
* enableAutomaticUpdates: true,
* workerPool: "worker-pool",
* environmentVariables: {
* FOO_KEY: "FOO_VALUE",
* BAR_KEY: "BAR_VALUE",
* },
* serviceAccount: cloudbuildServiceAccount.id,
* },
* }, {
* dependsOn: [
* actAs,
* logsWriter,
* ],
* });
* ```
*
* ## Import
*
* Service can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/services/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Service can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:cloudrunv2/service:Service default projects/{{project}}/locations/{{location}}/services/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:cloudrunv2/service:Service default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:cloudrunv2/service:Service default {{location}}/{{name}}
* ```
*/
class Service extends pulumi.CustomResource {
/**
* Get an existing Service resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Service(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Service. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Service.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["annotations"] = state ? state.annotations : undefined;
resourceInputs["binaryAuthorization"] = state ? state.binaryAuthorization : undefined;
resourceInputs["buildConfig"] = state ? state.buildConfig : undefined;
resourceInputs["client"] = state ? state.client : undefined;
resourceInputs["clientVersion"] = state ? state.clientVersion : undefined;
resourceInputs["conditions"] = state ? state.conditions : undefined;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["creator"] = state ? state.creator : undefined;
resourceInputs["customAudiences"] = state ? state.customAudiences : undefined;
resourceInputs["defaultUriDisabled"] = state ? state.defaultUriDisabled : undefined;
resourceInputs["deleteTime"] = state ? state.deleteTime : undefined;
resourceInputs["deletionProtection"] = state ? state.deletionProtection : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["effectiveAnnotations"] = state ? state.effectiveAnnotations : undefined;
resourceInputs["effectiveLabels"] = state ? state.effectiveLabels : undefined;
resourceInputs["etag"] = state ? state.etag : undefined;
resourceInputs["expireTime"] = state ? state.expireTime : undefined;
resourceInputs["generation"] = state ? state.generation : undefined;
resourceInputs["ingress"] = state ? state.ingress : undefined;
resourceInputs["invokerIamDisabled"] = state ? state.invokerIamDisabled : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["lastModifier"] = state ? state.lastModifier : undefined;
resourceInputs["latestCreatedRevision"] = state ? state.latestCreatedRevision : undefined;
resourceInputs["latestReadyRevision"] = state ? state.latestReadyRevision : undefined;
resourceInputs["launchStage"] = state ? state.launchStage : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["observedGeneration"] = state ? state.observedGeneration : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["pulumiLabels"] = state ? state.pulumiLabels : undefined;
resourceInputs["reconciling"] = state ? state.reconciling : undefined;
resourceInputs["scaling"] = state ? state.scaling : undefined;
resourceInputs["template"] = state ? state.template : undefined;
resourceInputs["terminalConditions"] = state ? state.terminalConditions : undefined;
resourceInputs["trafficStatuses"] = state ? state.trafficStatuses : undefined;
resourceInputs["traffics"] = state ? state.traffics : undefined;
resourceInputs["uid"] = state ? state.uid : undefined;
resourceInputs["updateTime"] = state ? state.updateTime : undefined;
resourceInputs["uri"] = state ? state.uri : undefined;
resourceInputs["urls"] = state ? state.urls : undefined;
}
else {
const args = argsOrState;
if ((!args || args.location === undefined) && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if ((!args || args.template === undefined) && !opts.urn) {
throw new Error("Missing required property 'template'");
}
resourceInputs["annotations"] = args ? args.annotations : undefined;
resourceInputs["binaryAuthorization"] = args ? args.binaryAuthorization : undefined;
resourceInputs["buildConfig"] = args ? args.buildConfig : undefined;
resourceInputs["client"] = args ? args.client : undefined;
resourceInputs["clientVersion"] = args ? args.clientVersion : undefined;
resourceInputs["customAudiences"] = args ? args.customAudiences : undefined;
resourceInputs["defaultUriDisabled"] = args ? args.defaultUriDisabled : undefined;
resourceInputs["deletionProtection"] = args ? args.deletionProtection : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["ingress"] = args ? args.ingress : undefined;
resourceInputs["invokerIamDisabled"] = args ? args.invokerIamDisabled : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["launchStage"] = args ? args.launchStage : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["scaling"] = args ? args.scaling : undefined;
resourceInputs["template"] = args ? args.template : undefined;
resourceInputs["traffics"] = args ? args.traffics : undefined;
resourceInputs["conditions"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["creator"] = undefined /*out*/;
resourceInputs["deleteTime"] = undefined /*out*/;
resourceInputs["effectiveAnnotations"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["expireTime"] = undefined /*out*/;
resourceInputs["generation"] = undefined /*out*/;
resourceInputs["lastModifier"] = undefined /*out*/;
resourceInputs["latestCreatedRevision"] = undefined /*out*/;
resourceInputs["latestReadyRevision"] = undefined /*out*/;
resourceInputs["observedGeneration"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["reconciling"] = undefined /*out*/;
resourceInputs["terminalConditions"] = undefined /*out*/;
resourceInputs["trafficStatuses"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
resourceInputs["uri"] = undefined /*out*/;
resourceInputs["urls"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Service.__pulumiType, name, resourceInputs, opts);
}
}
exports.Service = Service;
/** @internal */
Service.__pulumiType = 'gcp:cloudrunv2/service:Service';
//# sourceMappingURL=service.js.map