Skip to content

Commit f2cda8e

Browse files
authored
Merge pull request #5 from sparkfabrik/feat/update_readme
feat(doc): update the README
2 parents 16d71c0 + 4ebf33b commit f2cda8e

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [0.2.0] - 2024-04-02
99

10+
[Compare with previous version](https://github.com/sparkfabrik/terraform-google-gcp-project-resources-tags-helper/compare/0.1.0...0.2.0)
11+
1012
### Added
1113

1214
- Add support for Artifact Registry tags

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
# Helper module to bind tags to Google Cloud Platform resources
22

3-
A simple module used to retrieve tags data from a GCP project and to assign tags
4-
(binding) to passed resources. The module will create the bindings if they don't
5-
exist, but it will fail to create the bindings if they are already present.
3+
A simple module used to retrieve tags data from a GCP project and to assign tags
4+
(binding) to passed resources. The module will create the bindings if they don't
5+
exist, but it will fail to create the bindings if they are already present.
66

7-
Actually the **module supports tagging of storage buckets** and **CloudSQL instances**.
7+
Actually the **module supports tagging of**:
8+
9+
- **Cloud Storage buckets**
10+
- **CloudSQL instances**
11+
- **Artifact Registry repositories**
812

913
**IMPORTANT**: when tagging multi-regional buckets, check the location in the
1014
Google cloud console (for example it can be `eu`). When tagging clodSQL instances,
1115
you must specify the region as the location, not the zone (for example `europe-west1`
1216
and not `europe-west1-b`).
1317

14-
You can pass the tags to the module in a user-friendly and easy to read format,
18+
**IMPORTANT**: all the CloudSQL roles have to be granted at the project level as lowest-level.
19+
This means that you can tag resources only for convinience, but you can not use them in the IAM
20+
conditions.
21+
22+
You can pass the tags to the module in a user-friendly and easy to read format,
1523
<TAG_KEY_SHORTNAME>/<TAG_VALUE_SHORTNAME>, so that it will be easy to understand,
1624
for example, you can write tasgs to be applied to resources like:
1725

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

20-
You can also use the module to retrieve information about tags availables in your
28+
You can also use the module to retrieve information about tags availables in your
2129
project, populanting the variable `tags_to_be_discovered` with a full tag structure,
22-
where the tag key is the map key, and the tag values are the values of each map key.
30+
where the tag key is the map key, and the tag values are the values of each map key.
2331
For example:
2432

2533
```terraform

0 commit comments

Comments
 (0)