Skip to content

Commit

Permalink
add data catalog tag (#3569) (#56)
Browse files Browse the repository at this point in the history
* add data catalog tag

* add data catalog tag

* fix missing err check

* update after review comments

* fixing a bad diff

* update per code review comments

* update fields values to camel case in ruby

Signed-off-by: Modular Magician <[email protected]>
  • Loading branch information
modular-magician authored Jun 8, 2020
1 parent 24a9831 commit 5c49d80
Show file tree
Hide file tree
Showing 12 changed files with 571 additions and 0 deletions.
15 changes: 15 additions & 0 deletions data_catalog_entry_group_tag/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
72 changes: 72 additions & 0 deletions data_catalog_entry_group_tag/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
resource "google_data_catalog_entry" "first_entry" {
entry_group = google_data_catalog_entry_group.entry_group.id
entry_id = "first_entry-${local.name_suffix}"

user_specified_type = "my_custom_type"
user_specified_system = "SomethingExternal"
}

resource "google_data_catalog_entry" "second_entry" {
entry_group = google_data_catalog_entry_group.entry_group.id
entry_id = "second_entry-${local.name_suffix}"

user_specified_type = "another_custom_type"
user_specified_system = "SomethingElseExternal"
}

resource "google_data_catalog_entry_group" "entry_group" {
entry_group_id = "my_entry_group-${local.name_suffix}"
}

resource "google_data_catalog_tag_template" "tag_template" {
tag_template_id = "my_template-${local.name_suffix}"
region = "us-central1"
display_name = "Demo Tag Template"

fields {
field_id = "source"
display_name = "Source of data asset"
type {
primitive_type = "STRING"
}
is_required = true
}

fields {
field_id = "num_rows"
display_name = "Number of rows in the data asset"
type {
primitive_type = "DOUBLE"
}
}

fields {
field_id = "pii_type"
display_name = "PII type"
type {
enum_type {
allowed_values {
display_name = "EMAIL"
}
allowed_values {
display_name = "SOCIAL SECURITY NUMBER"
}
allowed_values {
display_name = "NONE"
}
}
}
}

force_delete = "true"
}

resource "google_data_catalog_tag" "entry_group_tag" {
parent = google_data_catalog_entry_group.entry_group.id
template = google_data_catalog_tag_template.tag_template.id

fields {
field_name = "source"
string_value = "my-string"
}
}
7 changes: 7 additions & 0 deletions data_catalog_entry_group_tag/motd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===

These examples use real resources that will be billed to the
Google Cloud Platform project you use - so make sure that you
run "terraform destroy" before quitting!

===
79 changes: 79 additions & 0 deletions data_catalog_entry_group_tag/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Data Catalog Entry Group Tag - Terraform

## Setup

<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="data_catalog_entry_group_tag" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>

Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.

<walkthrough-project-billing-setup></walkthrough-project-billing-setup>

Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.

## Terraforming!

Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
the project name from the environment variable.

```bash
export GOOGLE_CLOUD_PROJECT={{project-id}}
```

After that, let's get Terraform started. Run the following to pull in the providers.

```bash
terraform init
```

With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!

```bash
terraform apply
```

Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.

```bash
yes
```


## Post-Apply

### Editing your config

Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.

```bash
terraform plan
```

So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
run a 'plan' again.

```bash
terraform plan
```

Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
at the 'yes' prompt.

```bash
terraform apply
```

```bash
yes
```

## Cleanup

Run the following to remove the resources Terraform provisioned:

```bash
terraform destroy
```
```bash
yes
```
15 changes: 15 additions & 0 deletions data_catalog_entry_tag_basic/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
64 changes: 64 additions & 0 deletions data_catalog_entry_tag_basic/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
resource "google_data_catalog_entry" "entry" {
entry_group = google_data_catalog_entry_group.entry_group.id
entry_id = "my_entry-${local.name_suffix}"

user_specified_type = "my_custom_type"
user_specified_system = "SomethingExternal"
}

resource "google_data_catalog_entry_group" "entry_group" {
entry_group_id = "my_entry_group-${local.name_suffix}"
}

resource "google_data_catalog_tag_template" "tag_template" {
tag_template_id = "my_template-${local.name_suffix}"
region = "us-central1"
display_name = "Demo Tag Template"

fields {
field_id = "source"
display_name = "Source of data asset"
type {
primitive_type = "STRING"
}
is_required = true
}

fields {
field_id = "num_rows"
display_name = "Number of rows in the data asset"
type {
primitive_type = "DOUBLE"
}
}

fields {
field_id = "pii_type"
display_name = "PII type"
type {
enum_type {
allowed_values {
display_name = "EMAIL"
}
allowed_values {
display_name = "SOCIAL SECURITY NUMBER"
}
allowed_values {
display_name = "NONE"
}
}
}
}

force_delete = "true"
}

resource "google_data_catalog_tag" "basic_tag" {
parent = google_data_catalog_entry.entry.id
template = google_data_catalog_tag_template.tag_template.id

fields {
field_name = "source"
string_value = "my-string"
}
}
7 changes: 7 additions & 0 deletions data_catalog_entry_tag_basic/motd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===

These examples use real resources that will be billed to the
Google Cloud Platform project you use - so make sure that you
run "terraform destroy" before quitting!

===
79 changes: 79 additions & 0 deletions data_catalog_entry_tag_basic/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Data Catalog Entry Tag Basic - Terraform

## Setup

<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="data_catalog_entry_tag_basic" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>

Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.

<walkthrough-project-billing-setup></walkthrough-project-billing-setup>

Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.

## Terraforming!

Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
the project name from the environment variable.

```bash
export GOOGLE_CLOUD_PROJECT={{project-id}}
```

After that, let's get Terraform started. Run the following to pull in the providers.

```bash
terraform init
```

With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!

```bash
terraform apply
```

Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.

```bash
yes
```


## Post-Apply

### Editing your config

Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.

```bash
terraform plan
```

So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
run a 'plan' again.

```bash
terraform plan
```

Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
at the 'yes' prompt.

```bash
terraform apply
```

```bash
yes
```

## Cleanup

Run the following to remove the resources Terraform provisioned:

```bash
terraform destroy
```
```bash
yes
```
15 changes: 15 additions & 0 deletions data_catalog_entry_tag_full/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
Loading

0 comments on commit 5c49d80

Please sign in to comment.