https://github.com/GoogleCloudPlatform/terraform-google-cloud-run

Deploys apps to Cloud Run, along with option to map custom domain
https://github.com/GoogleCloudPlatform/terraform-google-cloud-run

cft-terraform cloudrun google-cloud-platform serverless-computing terraform-modules

Last synced: 4 months ago
JSON representation

Deploys apps to Cloud Run, along with option to map custom domain

Host: GitHub
URL: https://github.com/GoogleCloudPlatform/terraform-google-cloud-run
Owner: GoogleCloudPlatform
License: apache-2.0
Created: 2021-06-27T15:26:34.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-11-28T16:46:53.000Z (5 months ago)
Last Synced: 2024-11-28T17:21:58.148Z (5 months ago)
Topics: cft-terraform, cloudrun, google-cloud-platform, serverless-computing, terraform-modules
Language: HCL
Homepage: https://registry.terraform.io/modules/GoogleCloudPlatform/cloud-run/google
Size: 767 KB
Stars: 143
Watchers: 31
Forks: 95
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

jimsghstars - GoogleCloudPlatform/terraform-google-cloud-run - Deploys apps to Cloud Run, along with option to map custom domain (HCL)

README

        # Terraform Cloud Run Module

This module handles the basic deployment of containerized applications on Cloud Run, along with domain mapping and IAM policy for the service.

The resources/services/activations/deletions that this module will create/trigger are:

* Creates a Cloud Run service with provided name and container

* Creates Domain mapping for the deployed service

* Applies Cloud Run Invoker role to members

## Mapping custom domains and subdomains

You can map multiple custom domains and subdomains to the same Cloud Run service. If you want to register a domain with Cloud Domains, see [Registering a domain with Cloud Domains within the Cloud Run console](https://cloud.google.com/run/docs/mapping-custom-domains#register-domain).

To add a custom domain or subdomain to your Cloud Run service, you need to add the values to the `verified_domain_name` variable.

Before you've mapped your service to a custom domain in Cloud Run, you need to update your DNS records at your domain registry.

If you're using Cloud DNS as your DNS provider, see [Adding a record](https://cloud.google.com/dns/docs/records#adding_a_record).

In case your DNS is not managed by Google Cloud Domains, the ownership of your domain needs to be verified adding a `txt record` on your DNS configuration. This verification can be done following the steps from [this documentation](https://cloud.google.com/identity/docs/verify-domain-txt).

## Assumptions and Prerequisites

This module assumes that below mentioned prerequisites are in place before consuming the module.

* All required APIs are enabled in the GCP Project

* Cloud SQL (optional)

* VPC Connector (optional)

* Environment Variables in Secret Manager (optional)

## Usage

Basic usage of this module is as follows:

```hcl

module "cloud_run" {

  source  = "GoogleCloudPlatform/cloud-run/google"

  version = "~> 0.10.0"

  # Required variables

  service_name           = ""

  project_id             = ""

  location               = ""

  image                  = "gcr.io/cloudrun/hello"

}

```

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

| argument | Arguments passed to the ENTRYPOINT command, include these only if image entrypoint needs arguments | `list(string)` | `[]` | no |

| certificate\_mode | The mode of the certificate (NONE or AUTOMATIC) | `string` | `"NONE"` | no |

| container\_command | Leave blank to use the ENTRYPOINT command defined in the container image, include these only if image entrypoint should be overwritten | `list(string)` | `[]` | no |

| container\_concurrency | Concurrent request limits to the service | `number` | `null` | no |

| domain\_map\_annotations | Annotations to the domain map | `map(string)` | `{}` | no |

| domain\_map\_labels | A set of key/value label pairs to assign to the Domain mapping | `map(string)` | `{}` | no |

| encryption\_key | CMEK encryption key self-link expected in the format projects/PROJECT/locations/LOCATION/keyRings/KEY-RING/cryptoKeys/CRYPTO-KEY. | `string` | `null` | no |

| env\_secret\_vars | [Beta] Environment variables (Secret Manager) | 
list(object({
    name = string
    value_from = set(object({
      secret_key_ref = map(string)
    }))
  })) | `[]` | no |

| env\_vars | Environment variables (cleartext) | list(object({
    value = string
    name  = string
  })) | `[]` | no |

| force\_override | Option to force override existing mapping | `bool` | `false` | no |

| generate\_revision\_name | Option to enable revision name generation | `bool` | `true` | no |

| image | GCR hosted image URL to deploy | `string` | n/a | yes |

| limits | Resource limits to the container | `map(string)` | `null` | no |

| liveness\_probe | Periodic probe of container liveness. Container will be restarted if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | object({
    failure_threshold     = optional(number, null)
    initial_delay_seconds = optional(number, null)
    timeout_seconds       = optional(number, null)
    period_seconds        = optional(number, null)
    http_get = optional(object({
      path = optional(string)
      http_headers = optional(list(object({
        name  = string
        value = string
      })), null)
    }), null)
    grpc = optional(object({
      port    = optional(number)
      service = optional(string)
    }), null)
  }) | `null` | no |

| location | Cloud Run service deployment location | `string` | n/a | yes |

| members | Users/SAs to be given invoker access to the service | `list(string)` | `[]` | no |

| ports | Port which the container listens to (http1 or h2c) | object({
    name = string
    port = number
  })
 | {
  "name": "http1",
  "port": 8080
} | no |

| project\_id | The project ID to deploy to | `string` | n/a | yes |

| requests | Resource requests to the container | `map(string)` | `{}` | no |

| service\_account\_email | Service Account email needed for the service | `string` | `""` | no |

| service\_annotations | Annotations to the service. Acceptable values all, internal, internal-and-cloud-load-balancing | `map(string)` | {
  "run.googleapis.com/ingress": "all"
} | no |

| service\_labels | A set of key/value label pairs to assign to the service | `map(string)` | `{}` | no |

| service\_name | The name of the Cloud Run service to create | `string` | n/a | yes |

| startup\_probe | Startup probe of application within the container.
All other probes are disabled if a startup probe is provided, until it succeeds.
Container will not be added to service endpoints if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | object({
    failure_threshold     = optional(number, null)
    initial_delay_seconds = optional(number, null)
    timeout_seconds       = optional(number, null)
    period_seconds        = optional(number, null)
    http_get = optional(object({
      path = optional(string)
      http_headers = optional(list(object({
        name  = string
        value = string
      })), null)
    }), null)
    tcp_socket = optional(object({
      port = optional(number)
    }), null)
    grpc = optional(object({
      port    = optional(number)
      service = optional(string)
    }), null)
  }) | `null` | no |

| template\_annotations | Annotations to the container metadata including VPC Connector and SQL. See [more details](https://cloud.google.com/run/docs/reference/rpc/google.cloud.run.v1#revisiontemplate) | `map(string)` | {
  "autoscaling.knative.dev/maxScale": 2,
  "autoscaling.knative.dev/minScale": 1,
  "generated-by": "terraform",
  "run.googleapis.com/client-name": "terraform"
} | no |

| template\_labels | A set of key/value label pairs to assign to the container metadata | `map(string)` | `{}` | no |

| timeout\_seconds | Timeout for each request | `number` | `120` | no |

| traffic\_split | Managing traffic routing to the service | list(object({
    latest_revision = bool
    percent         = number
    revision_name   = string
    tag             = string
  }))
 | [
  {
    "latest_revision": true,
    "percent": 100,
    "revision_name": "v1-0-0",
    "tag": null
  }
] | no |

| verified\_domain\_name | List of Custom Domain Name | `list(string)` | `[]` | no |

| volume\_mounts | [Beta] Volume Mounts to be attached to the container (when using secret) | list(object({
    mount_path = string
    name       = string
  })) | `[]` | no |

| volumes | [Beta] Volumes needed for environment variables (when using secret) | list(object({
    name = string
    secret = set(object({
      secret_name = string
      items       = map(string)
    }))
  }))
 | `[]` | no |

## Outputs

| Name | Description |

|------|-------------|

| apphub\_service\_uri | Service URI in CAIS style to be used by Apphub. |

| domain\_map\_id | Unique Identifier for the created domain map |

| domain\_map\_status | Status of Domain mapping |

| location | Location in which the Cloud Run service was created |

| project\_id | Google Cloud project in which the service was created |

| revision | Deployed revision for the service |

| service\_id | Unique Identifier for the created service |

| service\_name | Name of the created service |

| service\_status | Status of the created service |

| service\_url | The URL on which the deployed service is available |

| verified\_domain\_name | List of Custom Domain Name |

## Requirements

These sections describe requirements for using this module.

### Software

- [Terraform](https://www.terraform.io/downloads.html) ~> v1.3+

- [Terraform Provider for GCP](https://github.com/terraform-providers/terraform-provider-google) < 6

- [Terraform Provider for GCP Beta](https://github.com/terraform-providers/terraform-provider-google-beta) < 6

### Service Account

A service account can be used with required roles to execute this module:

- Cloud Run Admin: `roles/run.admin`

Know more about [Cloud Run Deployment Permissions](https://cloud.google.com/run/docs/reference/iam/roles#additional-configuration).

The [Project Factory module](https://registry.terraform.io/modules/terraform-google-modules/project-factory/google/latest) and the

[IAM module](https://registry.terraform.io/modules/terraform-google-modules/iam/google/latest) may be used in combination to provision a service account with the necessary roles applied.

### APIs

A project with the following APIs enabled must be used to host the main resource of this module:

- Google Cloud Run: `run.googleapis.com`

- Serverless VPC Access (optional): `vpcaccess.googleapis.com`

- Cloud SQL (optional): `sqladmin.googleapis.com`

## Contributing

Refer to the [contribution guidelines](./CONTRIBUTING.md) for

information on contributing to this module.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/GoogleCloudPlatform/terraform-google-cloud-run

Awesome Lists containing this project

README