Skip to content

Commit

Permalink
Merge branch 'main' into renovate/configure
Browse files Browse the repository at this point in the history
  • Loading branch information
bschaatsbergen authored Mar 28, 2024
2 parents 33e4b2e + 0db4b95 commit 8c8c239
Show file tree
Hide file tree
Showing 13 changed files with 32 additions and 30 deletions.
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @runatlantis/terraform-contributors
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Atlantis on Google Compute Engine

![Header](./static/banner.png)

This Terraform module deploys various resources to run Atlantis on Google Compute Engine.

- [Feature highlights](#feature-highlights)
Expand Down Expand Up @@ -53,29 +55,28 @@ This module expects that you already own or create the below resources yourself.
- Service account
- Domain

If you prefer an example that includes the above resources, see [`complete example`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete).
If you prefer an example that includes the above resources, see [`complete example`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete).

## Example Usage

Here are some examples to choose from. Look at the prerequisites above to find one that is appropriate for your configuration.

- [Basic](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic)
- [Complete](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete)
- [Secure Environment Variables](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars)
- [Cloud Armor](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/cloud-armor)
- [Shared VPC](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/shared-vpc)
- [Basic](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic)
- [Complete](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete)
- [Secure Environment Variables](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars)
- [Cloud Armor](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/cloud-armor)
- [Shared VPC](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/shared-vpc)

```hcl
module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
version = "1.3.1"
source = "runatlantis/atlantis/gce"
# insert the 7 required variables here
}
```

## How to deploy

See [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic/main.tf) and the [`server-atlantis.yaml`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic/server-atlantis.yaml).
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic/main.tf) and the [`server-atlantis.yaml`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic/server-atlantis.yaml).

### Important

Expand Down Expand Up @@ -103,7 +104,7 @@ For an overview of all possible environment variables, see: [Atlantis Server Con

### Setting sensitive environment variables

See [secured environment variables](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars) for an example on how to deal with sensitive values in environment variables.
See [secured environment variables](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars) for an example on how to deal with sensitive values in environment variables.

## Service Account

Expand All @@ -115,7 +116,7 @@ Note that you must grant the relevant permissions to your service account yourse

The `roles/logging.logWriter` & `roles/monitoring.metricWriter` roles should be attached to the service account in order to write logs to Cloud Logging and ingest metric data into Cloud Monitoring.

See [`main.tf`](https://github.com/bschaatsbergen/terraform-gce-atlantis/blob/main/examples/basic/main.tf#L16-L33)
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/blob/main/examples/basic/main.tf#L16-L33)

## DNS Record

Expand All @@ -127,7 +128,7 @@ It's a requirement to add the A record to the domain record set in order to suce

If you use Cloud DNS and own a managed zone for your domain, use the IP address that's part of the module output to create the A record.

See [`main.tf`](https://github.com/bschaatsbergen/terraform-gce-atlantis/blob/main/examples/basic/main.tf#L60-L71)
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/blob/main/examples/basic/main.tf#L60-L71)

## Identity-Aware Proxy

Expand Down
4 changes: 2 additions & 2 deletions examples/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ This module expects that you already own or create the below resources yourself.
- Service account, [specifics can be found here](../../README.md#service-account)
- Domain, [specifics can be found here](../../README.md#dns-record)

If you prefer an example that includes the above resources, see [`complete example`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete).
If you prefer an example that includes the above resources, see [`complete example`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete).

## How to deploy

See [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic/main.tf) and the [`server-atlantis.yaml`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic/server-atlantis.yaml).
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic/main.tf) and the [`server-atlantis.yaml`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic/server-atlantis.yaml).

## After it's successfully deployed

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ resource "google_project_iam_member" "atlantis_metric_writer" {
}

module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
source = "runatlantis/atlantis/gce"
name = "atlantis"
network = local.network
subnetwork = local.subnetwork
Expand Down
4 changes: 2 additions & 2 deletions examples/cloud-armor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ This module expects that you already own or create the below resources yourself.
- Service account, [specifics can be found here](../../README.md#service-account)
- Domain, [specifics can be found here](../../README.md#dns-record)

If you prefer an example that includes the above resources, see [`complete example`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete).
If you prefer an example that includes the above resources, see [`complete example`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete).

## How to deploy

See [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/cloud-armor/main.tf) and the [`server-atlantis.yaml`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/cloud-armor/server-atlantis.yaml).
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/cloud-armor/main.tf) and the [`server-atlantis.yaml`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/cloud-armor/server-atlantis.yaml).

## After it's successfully deployed

Expand Down
2 changes: 1 addition & 1 deletion examples/cloud-armor/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ resource "google_project_iam_member" "atlantis_metric_writer" {
}

module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
source = "runatlantis/atlantis/gce"
name = "atlantis"
network = local.network
subnetwork = local.subnetwork
Expand Down
4 changes: 2 additions & 2 deletions examples/complete/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ This module expects that you already own or create the below resources yourself.

## How to deploy

See [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete/main.tf) and the [`server-atlantis.yaml`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete/server-atlantis.yaml).
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete/main.tf) and the [`server-atlantis.yaml`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete/server-atlantis.yaml).

### Important

- The [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete/main.tf) contains resources that are set up with only the minimum required attributes to function properly. It is recommended to add additional attributes if you plan to use this in a production environment.
- The [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete/main.tf) contains resources that are set up with only the minimum required attributes to function properly. It is recommended to add additional attributes if you plan to use this in a production environment.

## After it's successfully deployed

Expand Down
2 changes: 1 addition & 1 deletion examples/complete/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ resource "google_compute_router_nat" "default" {
}

module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
source = "runatlantis/atlantis/gce"
name = "atlantis"
network = google_compute_network.default.name
subnetwork = google_compute_subnetwork.default.name
Expand Down
10 changes: 5 additions & 5 deletions examples/secure-env-vars/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Securing sensitive environment variables

This guide explains how to secure environment variables when using the Atlantis module on Google Cloud Platform. For more information on using this module, see the [`basic example`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/basic).
This guide explains how to secure environment variables when using the Atlantis module on Google Cloud Platform. For more information on using this module, see the [`basic example`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/basic).

- [Prerequisites](#prerequisites)
- [How to deploy](#how-to-deploy)
Expand All @@ -17,7 +17,7 @@ You should already have the following resources:

## How to deploy

To deploy the Atlantis module, see [`Dockerfile`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars/Dockerfile) and the [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars/main.tf).
To deploy the Atlantis module, see [`Dockerfile`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars/Dockerfile) and the [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars/main.tf).

### Important

Expand All @@ -31,9 +31,9 @@ Atlantis allows you to configure everything using environment variables. However

Use a wrapper Atlantis Docker image to set environment variables that contain sensitive values. See the following examples for more details:

- [**Cloud Build**: pull secrets from Google Secret Manager](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars/cloudbuild.yaml)
- [**GitHub Actions**: pull secrets from Google Secret Manager](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars/.github/workflows/docker-gcp-secrets.yaml)
- [**GitHub Actions**: use GitHub secrets](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/secure-env-vars/.github/workflows/docker-github-secrets.yaml)
- [**Cloud Build**: pull secrets from Google Secret Manager](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars/cloudbuild.yaml)
- [**GitHub Actions**: pull secrets from Google Secret Manager](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars/.github/workflows/docker-gcp-secrets.yaml)
- [**GitHub Actions**: use GitHub secrets](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/secure-env-vars/.github/workflows/docker-github-secrets.yaml)

### Setting non-sensitive environment variables

Expand Down
2 changes: 1 addition & 1 deletion examples/secure-env-vars/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ resource "google_project_iam_member" "atlantis_metric_writer" {
}

module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
source = "runatlantis/atlantis/gce"
name = "atlantis"
image = local.image # Your wrapper Atlantis Docker image
network = local.network
Expand Down
4 changes: 2 additions & 2 deletions examples/shared-vpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ This module expects that you already own or create the below resources yourself.
- target tags: [allow-iap]
- tcp, port 22

If you prefer an example that includes the above resources, see [`complete example`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/complete).
If you prefer an example that includes the above resources, see [`complete example`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/complete).

## How to deploy

See [`main.tf`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/shared-vpc/main.tf) and the [`server-atlantis.yaml`](https://github.com/bschaatsbergen/atlantis-on-gcp-vm/tree/master/examples/shared-vpc/server-atlantis.yaml).
See [`main.tf`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/shared-vpc/main.tf) and the [`server-atlantis.yaml`](https://github.com/runatlantis/terraform-gce-atlantis/tree/master/examples/shared-vpc/server-atlantis.yaml).

## After it's successfully deployed

Expand Down
2 changes: 1 addition & 1 deletion examples/shared-vpc/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ resource "google_project_iam_member" "atlantis_metric_writer" {
}

module "atlantis" {
source = "bschaatsbergen/atlantis/gce"
source = "runatlantis/atlantis/gce"
name = "atlantis"
network = local.network
subnetwork = local.subnetwork
Expand Down
Binary file added static/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c8c239

Please sign in to comment.