Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sparkfabrik/terraform-google-gcp-project-resources-tags-helper

A simple module used to retrieve tags data from a GCP project and to assign tags (binding) to passed resources.
https://github.com/sparkfabrik/terraform-google-gcp-project-resources-tags-helper

Last synced: 8 days ago
JSON representation

A simple module used to retrieve tags data from a GCP project and to assign tags (binding) to passed resources.

Host: GitHub
URL: https://github.com/sparkfabrik/terraform-google-gcp-project-resources-tags-helper
Owner: sparkfabrik
License: gpl-3.0
Created: 2023-08-03T08:56:32.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-12-16T10:39:04.000Z (24 days ago)
Last Synced: 2024-12-16T11:35:27.130Z (24 days ago)
Language: HCL
Size: 44.9 KB
Stars: 0
Watchers: 7
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Helper module to bind tags to Google Cloud Platform resources

A simple module used to retrieve tags data from a GCP project and to assign tags

(binding) to passed resources. The module will create the bindings if they don't

exist, but it will fail to create the bindings if they are already present.

Actually the **module supports tagging of**:

- **Cloud Storage buckets**

- **CloudSQL instances**

- **Artifact Registry repositories**

**IMPORTANT**: when tagging multi-regional buckets, check the location in the

Google cloud console (for example it can be `eu`). When tagging clodSQL instances,

you must specify the region as the location, not the zone (for example `europe-west1`

and not `europe-west1-b`).

**IMPORTANT**: all the CloudSQL roles have to be granted at the project level as lowest-level.

This means that you can tag resources only for convinience, but you can not use them in the IAM

conditions.

You can pass the tags to the module in a user-friendly and easy to read format,

/, so that it will be easy to understand,

for example, you can write tasgs to be applied to resources like:

`["dev-team/viewer", "ops-team/admin"]`

You can also use the module to retrieve information about tags availables in your

project, populanting the variable `tags_to_be_discovered` with a full tag structure,

where the tag key is the map key, and the tag values are the values of each map key.

For example:

```terraform

    tags_to_be_discovered = {

        "dev-team" : [

          "viewer",

          "editor",

          "admin"

        ],

        "ops-team" : [

          "viewer",

          "editor",

          "admin"

        ]

    }

```

In the module output you can retrieve all tags keys and values informations.

## Providers

| Name | Version |

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

|  [google](#provider\_google) | >= 4.47.0 |

## Requirements

| Name | Version |

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

|  [terraform](#requirement\_terraform) | >= 1.2 |

|  [google](#requirement\_google) | >= 4.47.0 |

## Inputs

| Name | Description | Type | Default | Required |

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

|  [artifact\_registry\_repositories\_to\_be\_tagged](#input\_artifact\_registry\_repositories\_to\_be\_tagged) | A structured list of objects, containing the list of repositories we want to tag, with repository id, repository location (region) and tag values. | 
list(object({
    repository_id       = string
    repository_location = optional(string, null)
    tags                = optional(list(string), [])
  })) | `[]` | no |

|  [buckets\_to\_be\_tagged](#input\_buckets\_to\_be\_tagged) | A structured list of objects, containing the list of buckets we want to tag and the tag values, in the form `/`. If no bucket\_location is specified, the value of default\_location will be used. | list(object({
    bucket_name     = string
    bucket_location = optional(string, null)
    tags            = optional(list(string), [])
  })) | `[]` | no |

|  [cloudsql\_instances\_to\_be\_tagged](#input\_cloudsql\_instances\_to\_be\_tagged) | A structured list of objects, containing the list of cloudSQL instances we want to tag, with instance name, instance location (region) and tag values. | list(object({
    instance_id       = string
    instance_location = optional(string, null)
    tags              = optional(list(string), [])
  })) | `[]` | no |

|  [default\_location](#input\_default\_location) | The default location (region) used for the resources to be tagged. | `string` | n/a | yes |

|  [global\_tags](#input\_global\_tags) | A list of tags to be applied to all the resources, in the form tag\_key\_short\_name/tag\_value\_short\_name. If a resource specify a list of tags, the global tags will overridden and replaced by those specified in the resource. | `list(string)` | `[]` | no |

|  [project\_id](#input\_project\_id) | The Google Cloud project ID. | `string` | n/a | yes |

|  [tags\_to\_be\_discovered](#input\_tags\_to\_be\_discovered) | The map with the tags we want to discover with a full structure key / values, see the README.md for an example. The module will print the tag informations as output. | `map(list(string))` | `{}` | no |

## Outputs

| Name | Description |

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

|  [discovered\_tag\_keys](#output\_discovered\_tag\_keys) | n/a |

|  [discovered\_tag\_keys\_ids](#output\_discovered\_tag\_keys\_ids) | n/a |

|  [discovered\_tag\_keys\_names](#output\_discovered\_tag\_keys\_names) | n/a |

|  [discovered\_tag\_values](#output\_discovered\_tag\_values) | n/a |

|  [discovered\_tag\_values\_ids](#output\_discovered\_tag\_values\_ids) | n/a |

## Resources

| Name | Type |

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

| [google_tags_location_tag_binding.artifact_registry](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/tags_location_tag_binding) | resource |

| [google_tags_location_tag_binding.buckets](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/tags_location_tag_binding) | resource |

| [google_tags_location_tag_binding.cloudsql](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/tags_location_tag_binding) | resource |

| [google_tags_tag_key.project_tag_keys_to_discover](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/tags_tag_key) | data source |

| [google_tags_tag_key.tag_keys](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/tags_tag_key) | data source |

| [google_tags_tag_value.project_tag_values_to_be_discovered](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/tags_tag_value) | data source |

| [google_tags_tag_value.tag_values](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/tags_tag_value) | data source |

## Modules

No modules.