Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terraform script to automate GCP provisioning for gcplog #3206

Merged
merged 2 commits into from
Jan 26, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,8 @@ coverage.txt

# emacs
.#*

# terraform
.terraform*
*.tfstate*
*.tfvars
45 changes: 45 additions & 0 deletions scripts/gcplog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Cloud provisioning for GCP logs

This document covers how to configure your GCP via Terraform to make cloud logs available for `promtail` to consume.

## Prerequisite
- Terraform >= 0.14.5
- GCP Service account credentials with following roles/permissions
- "roles/pubsub.editor"
- "roles/logging.configWriter"

## Usage

```bash
terraform init
```

```bash
terraform plan
```

```bash
terraform apply
```

Terraform will prompt for following variables.

1. credentials_file - ServiceAccount credentials file with permissions mentioned in the prerequisite.
2. zone - GCP zone (e.g: `us-central1-b`)
3. region - GCP region (e.g: `us-central1`)
4. project - GCP Project ID
5. logname - Logname is the name we use to create pubsub topics, log router and pubsub subscription.

you can pass these variables via CLI.

e.g:
```bash
terraform apply \
-var="credentials_file=./permissions.json" \
-var="zone=us-central1-b" \
-var="region=us-central1" \
-var="project=grafanalabs-dev" \
-var="logname=cloud-logs"
```

These variables can be passed in multiple ways. For complete reference refer terraform [doc](https://www.terraform.io/docs/configuration/variables.html#assigning-values-to-root-module-variables)
40 changes: 40 additions & 0 deletions scripts/gcplog/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
terraform {
required_providers {
google = {
source = "hashicorp/google"
version = "3.5.0"
}
}
}

variable "credentials_file" {}
variable "zone" {}
variable "region" {}
variable "project" {}
variable "logname" {
default = "cloud-logs"
}

provider "google" {
credentials = file(var.credentials_file)
project = var.project
zone = var.zone
region= var.region

}

resource "google_pubsub_topic" "cloud-logs" {
name= var.logname
}

resource "google_logging_project_sink" "cloud-logs" {
name = var.logname
destination = "pubsub.googleapis.com/projects/personal-226821/topics/${var.logname}"
filter = "resource.type = gcs_bucket AND severity >= WARNING"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

currently, filter is hardcoded. I will add it as variable in future.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should add to the doc a small section about this filter, the langage , what it does, and let's suggest a sane default ? What do you think would be a good default for someone that wants to get visibility into his cloud ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a sane default. Perhaps we can link to GCP's filter documentation in the README, but I don't think we need to add much tooling here to change it -- this can serve as a template.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with filter doc and sane defaults.

  1. Added some explanation on the README with doc link
  2. I think sane default would be some cloud resource most of the customer be having. httpLoadBalancer? so I added that. wdyt?

unique_writer_identity = true
}

resource "google_pubsub_subscription" "coud-logs" {
name = var.logname
topic = google_pubsub_topic.cloud-logs.name
}