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

feat(TPG>=4.78)!: add cloud storage subscription support #145

Merged
merged 9 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
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
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,18 @@ module "pubsub" {
drop_unknown_fields = false // optional
}
]
cloud_storage_subscriptions = [
{
name = "cloud-storage" // required
bucket = "example-bucket" // required
filename_prefix = "log_events_" // optional
filename_suffix = ".avro" // optional
max_duration = "60s" // optional
max_bytes = "10000000" // optional
output_format = "avro" // optional
write_metadata = false // optional
}
]
}
```

Expand All @@ -67,7 +79,8 @@ module "pubsub" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| bigquery\_subscriptions | The list of the bigquery push subscriptions. | `list(map(string))` | `[]` | no |
| bigquery\_subscriptions | The list of the Bigquery push subscriptions. | `list(map(string))` | `[]` | no |
| cloud\_storage\_subscriptions | The list of the Cloud Storage push subscriptions. | `list(map(string))` | `[]` | no |
| create\_subscriptions | Specify true if you want to create subscriptions. | `bool` | `true` | no |
| create\_topic | Specify true if you want to create a topic. | `bool` | `true` | no |
| grant\_token\_creator | Specify true if you want to add token creator role to the default Pub/Sub SA. | `bool` | `true` | no |
Expand Down
20 changes: 20 additions & 0 deletions examples/bigquery/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintTest
metadata:
name: bigquery
spec:
skip: true
apeabody marked this conversation as resolved.
Show resolved Hide resolved
36 changes: 36 additions & 0 deletions examples/cloud_storage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Cloud Storage Example

This example illustrates how to use the `pubsub` module.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| project\_id | The project ID to manage the Pub/Sub resources | `string` | n/a | yes |
| bucket\_name | The name of the GCS bucket name to which to write messages | `string` | n/a | yes |

## Outputs

| Name | Description |
|------|-------------|
| project\_id | The project ID |
| bucket\_name | The name of the Cloud Storage bucket created |
| topic\_name | The name of the Pub/Sub topic created |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## Requirements

The following sections describe the requirements which must be met in
order to invoke this example. The requirements of the
[root module][root-module-requirements] must be met.

## Usage

To provision this example, populate `terraform.tfvars` with the [required variables](#inputs) and run the following commands within
this directory:
- `terraform init` to get the plugins
- `terraform plan` to see the infrastructure plan
- `terraform apply` to apply the infrastructure build
- `terraform destroy` to destroy the built infrastructure
43 changes: 43 additions & 0 deletions examples/cloud_storage/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

provider "google" {
region = "europe-west1"
}

module "pubsub" {
source = "../../"
project_id = var.project_id
topic = "cft-tf-pubsub-topic-cloud-storage"

cloud_storage_subscriptions = [
{
name = "example_subscription"
bucket = var.bucket_name
},
]

depends_on = [
google_storage_bucket.test
]

}

resource "google_storage_bucket" "test" {
project = var.project_id
name = var.bucket_name
location = "europe-west1"
}
30 changes: 30 additions & 0 deletions examples/cloud_storage/outputs.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

output "project_id" {
value = var.project_id
description = "The project ID"
}

output "bucket_name" {
value = var.bucket_name
description = "The name of the Cloud Storage bucket created"
}

output "topic_name" {
value = module.pubsub.topic
description = "The name of the Pub/Sub topic created"
}
20 changes: 20 additions & 0 deletions examples/cloud_storage/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintTest
metadata:
name: cloud-storage
spec:
skip: true
apeabody marked this conversation as resolved.
Show resolved Hide resolved
24 changes: 24 additions & 0 deletions examples/cloud_storage/variables.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

variable "project_id" {
type = string
description = "The project ID to manage the Pub/Sub resources"
}
variable "bucket_name" {
type = string
description = "The name of the GCS bucket name to which to write messages"
}
25 changes: 25 additions & 0 deletions examples/cloud_storage/versions.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/**
apeabody marked this conversation as resolved.
Show resolved Hide resolved
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

terraform {
required_providers {
google = {
source = "hashicorp/google"
version = "~> 4.78"
}
}
required_version = ">= 0.13"
}
83 changes: 83 additions & 0 deletions main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ resource "google_project_iam_member" "bigquery_data_editor_binding" {
member = "serviceAccount:${local.pubsub_svc_account_email}"
}

resource "google_project_iam_member" "storage_admin_binding" {
count = length(var.cloud_storage_subscriptions) != 0 ? 1 : 0
project = var.project_id
role = "roles/storage.admin"
member = "serviceAccount:${local.pubsub_svc_account_email}"
}

resource "google_project_iam_member" "token_creator_binding" {
count = var.grant_token_creator ? 1 : 0
project = var.project_id
Expand Down Expand Up @@ -337,6 +344,82 @@ resource "google_pubsub_subscription" "bigquery_subscriptions" {
]
}

resource "google_pubsub_subscription" "cloud_storage_subscriptions" {
for_each = var.create_subscriptions ? { for i in var.cloud_storage_subscriptions : i.name => i } : {}

name = each.value.name
topic = var.create_topic ? google_pubsub_topic.topic[0].name : var.topic
project = var.project_id
labels = var.subscription_labels
ack_deadline_seconds = lookup(
each.value,
"ack_deadline_seconds",
local.default_ack_deadline_seconds,
)
message_retention_duration = lookup(
each.value,
"message_retention_duration",
null,
)
retain_acked_messages = lookup(
each.value,
"retain_acked_messages",
null,
)
filter = lookup(
each.value,
"filter",
null,
)
enable_message_ordering = lookup(
each.value,
"enable_message_ordering",
null,
)
dynamic "expiration_policy" {
// check if the 'expiration_policy' key exists, if yes, return a list containing it.
for_each = contains(keys(each.value), "expiration_policy") ? [each.value.expiration_policy] : []
content {
ttl = expiration_policy.value
}
}

dynamic "dead_letter_policy" {
for_each = (lookup(each.value, "dead_letter_topic", "") != "") ? [each.value.dead_letter_topic] : []
content {
dead_letter_topic = lookup(each.value, "dead_letter_topic", "")
max_delivery_attempts = lookup(each.value, "max_delivery_attempts", "5")
}
}

dynamic "retry_policy" {
for_each = (lookup(each.value, "maximum_backoff", "") != "") ? [each.value.maximum_backoff] : []
content {
maximum_backoff = lookup(each.value, "maximum_backoff", "")
minimum_backoff = lookup(each.value, "minimum_backoff", "")
}
}

cloud_storage_config {
bucket = each.value["bucket"]
filename_prefix = lookup(each.value, "filename_prefix", null)
filename_suffix = lookup(each.value, "filename_suffix", null)
max_duration = lookup(each.value, "max_duration", null)
max_bytes = lookup(each.value, "max_bytes", null)
dynamic "avro_config" {
for_each = (lookup(each.value, "output_format", "") == "avro") ? [true] : []
content {
write_metadata = lookup(each.value, "write_metadata", null)
}
}
}

depends_on = [
google_pubsub_topic.topic,
google_project_iam_member.storage_admin_binding
]
}

resource "google_pubsub_subscription_iam_member" "pull_subscription_sa_binding_subscriber" {
for_each = var.create_subscriptions ? { for i in var.pull_subscriptions : i.name => i if lookup(i, "service_account", null) != null } : {}

Expand Down
2 changes: 2 additions & 0 deletions outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ output "subscription_names" {
values({ for k, v in google_pubsub_subscription.push_subscriptions : k => v.name }),
values({ for k, v in google_pubsub_subscription.pull_subscriptions : k => v.name }),
values({ for k, v in google_pubsub_subscription.bigquery_subscriptions : k => v.name }),
values({ for k, v in google_pubsub_subscription.cloud_storage_subscriptions : k => v.name }),
)

description = "The name list of Pub/Sub subscriptions"
Expand All @@ -49,6 +50,7 @@ output "subscription_paths" {
values({ for k, v in google_pubsub_subscription.push_subscriptions : k => v.id }),
values({ for k, v in google_pubsub_subscription.pull_subscriptions : k => v.id }),
values({ for k, v in google_pubsub_subscription.bigquery_subscriptions : k => v.name }),
values({ for k, v in google_pubsub_subscription.cloud_storage_subscriptions : k => v.name }),
)

description = "The path list of Pub/Sub subscriptions"
Expand Down
3 changes: 2 additions & 1 deletion test/setup/iam.tf
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ locals {
int_required_roles = [
"roles/pubsub.admin",
"roles/resourcemanager.projectIamAdmin",
"roles/bigquery.admin"
"roles/bigquery.admin",
"roles/storage.admin"
]
}

Expand Down
1 change: 1 addition & 0 deletions test/setup/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ module "project-ci-int-pubsub" {
"pubsub.googleapis.com",
"serviceusage.googleapis.com",
"bigquery.googleapis.com",
"storage.googleapis.com"
]
}
4 changes: 2 additions & 2 deletions test/setup/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ terraform {
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.23"
version = "~> 4.78"
apeabody marked this conversation as resolved.
Show resolved Hide resolved
}
google-beta = {
source = "hashicorp/google-beta"
version = ">= 4.23"
version = "~> 4.78"
apeabody marked this conversation as resolved.
Show resolved Hide resolved
}
null = {
source = "hashicorp/null"
Expand Down
8 changes: 7 additions & 1 deletion variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,13 @@ variable "pull_subscriptions" {

variable "bigquery_subscriptions" {
type = list(map(string))
description = "The list of the bigquery push subscriptions."
description = "The list of the Bigquery push subscriptions."
default = []
}

variable "cloud_storage_subscriptions" {
type = list(map(string))
description = "The list of the Cloud Storage push subscriptions."
default = []
}

Expand Down
Loading
Loading