From 87d2c6f0da89c6400331f4aab96b214a282a519a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Gniewek-W=C4=99grzyn?= Date: Tue, 5 Nov 2024 14:54:06 +0100 Subject: [PATCH 1/4] feat: remove support of `context.tf` in favor of context provider --- .pre-commit-config.yaml | 4 +- .tflint.hcl | 3 - README.md | 83 +++++---- context.tf | 279 ------------------------------ examples/complete/README.md | 33 +--- examples/complete/context.tf | 279 ------------------------------ examples/complete/fixtures.tfvars | 25 +-- examples/complete/main.tf | 27 ++- examples/complete/outputs.tf | 9 +- examples/complete/providers.tf | 11 ++ examples/complete/variables.tf | 4 + examples/complete/versions.tf | 8 +- examples/simple/README.md | 4 +- examples/simple/versions.tf | 2 +- locals.tf | 21 ++- main.tf | 107 ++++++------ outputs.tf | 7 +- variables.tf | 39 ++++- versions.tf | 6 +- 19 files changed, 227 insertions(+), 724 deletions(-) delete mode 100644 .tflint.hcl delete mode 100644 context.tf delete mode 100644 examples/complete/context.tf create mode 100644 examples/complete/variables.tf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a646d0b..2692f2a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,8 +5,8 @@ repos: - id: terraform-validate # It should be the first step as it runs terraform init required by tflint - id: terraform-fmt - id: tflint - args: - - "--config=__GIT_ROOT__/.tflint.hcl" + # args: + # - "--config=__GIT_ROOT__/.tflint.hcl" - repo: https://github.com/terraform-docs/terraform-docs rev: "v0.18.0" # Get the latest from: https://github.com/terraform-docs/terraform-docs/releases diff --git a/.tflint.hcl b/.tflint.hcl deleted file mode 100644 index 3b6ace1..0000000 --- a/.tflint.hcl +++ /dev/null @@ -1,3 +0,0 @@ -rule "terraform_standard_module_structure" { - enabled = false # Fails on context.tf -} diff --git a/README.md b/README.md index b55e771..f130bbc 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,12 @@ Terraform module for Snowflake stage management. -* Creates Snowflake stage -* Can create custom Snowflake database-roles with role-to-role assignments -* Can create a set of default roles to simplify access management: - * `READONLY` - granted `USAGE` or `READ` privilages - * `READWRITE` - granted `WRITE` privileges - * `ADMIN` - granted `ALL PRIVILEGES` +- Creates Snowflake stage +- Can create custom Snowflake database-roles with role-to-role assignments +- Can create a set of default roles to simplify access management: + - `READONLY` - granted `USAGE` or `READ` privilages + - `READWRITE` - granted `WRITE` privileges + - `ADMIN` - granted `ALL PRIVILEGES` ## USAGE @@ -44,11 +44,12 @@ module "snowflake_stage" { - [Simple](examples/simple) - Basic usage of the module - [Complete](examples/complete) - Advanced usage of the module - ## Breaking changes in v2.x of the module + Due to breaking changes in Snowflake provider and additional code optimizations, **breaking changes** were introduced in `v2.0.0` version of this module. List of code and variable (API) changes: + - Switched to `snowflake_grant_ownership` resource instead of provider-removed `snowflake_role_ownership_grant` - Switched to `snowflake_database_role` module to leverage new `database_roles` mechanism - `default_roles` and `custom_roles` are now combined and managed by single module @@ -72,6 +73,36 @@ When upgrading from `v1.x`, expect most of the resources to be recreated - if re For more information, refer to [variables.tf](variables.tf), list of inputs below and Snowflake provider documentation +## Breaking changes in v3.x of the module + +Due to replacement of nulllabel (`context.tf`) with context provider, some **breaking changes** were introduced in `v3.0.0` version of this module. + +List od code and variable (API) changes: + +- Removed `context.tf` file (a single-file module with additonal variables), which implied a removal of all its variables (except `name`): + - `descriptor_formats` + - `label_value_case` + - `label_key_case` + - `id_length_limit` + - `regex_replace_chars` + - `label_order` + - `additional_tag_map` + - `tags` + - `labels_as_tags` + - `attributes` + - `delimiter` + - `stage` + - `environment` + - `tenant` + - `namespace` + - `enabled` + - `context` +- Remove support `enabled` flag - that might cause some backward compatibility issues with terraform state (please take into account that proper `move` clauses were added to minimize the impact), but proceed with caution +- Additional `context` provider configuration +- New variables were added, to allow naming configuration via `context` provider: + - `context_templates` + - `name_schema` + @@ -81,39 +112,23 @@ For more information, refer to [variables.tf](variables.tf), list of inputs belo | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no | -| [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element. | `list(string)` | `[]` | no | | [aws\_external\_id](#input\_aws\_external\_id) | ID of the customer AWS account | `string` | `null` | no | | [comment](#input\_comment) | Specifies a comment for the stage | `string` | `null` | no | -| [context](#input\_context) | Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
| no | +| [context\_templates](#input\_context\_templates) | Map of context templates used for naming conventions - this variable supersedes `naming_scheme.properties` and `naming_scheme.delimiter` configuration | `map(string)` | `{}` | no | | [copy\_options](#input\_copy\_options) | Specifies the copy options for the stage | `string` | `null` | no | | [create\_default\_roles](#input\_create\_default\_roles) | Whether the default database roles should be created | `bool` | `false` | no | | [credentials](#input\_credentials) | Specifies the credentials for the stage | `string` | `null` | no | | [database](#input\_database) | The database in which to create the stage | `string` | n/a | yes | -| [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | -| [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
format = string
labels = list(string)
}`
(Type is `any` so the map values can later be enhanced to provide additional options.)
`format` is a Terraform format string to be passed to the `format()` function.
`labels` is a list of labels, in order, to pass to `format()` function.
Label values will be normalized before being passed to `format()` so they will be
identical to how they appear in `id`.
Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no | -| [descriptor\_name](#input\_descriptor\_name) | Name of the descriptor used to form a resource name | `string` | `"snowflake-stage"` | no | | [directory](#input\_directory) | Specifies the directory settings for the stage | `string` | `null` | no | -| [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | | [encryption](#input\_encryption) | Specifies the encryption settings for the stage | `string` | `null` | no | -| [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no | | [file\_format](#input\_file\_format) | Specifies the file format for the stage | `string` | `null` | no | -| [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).
Set to `0` for unlimited length.
Set to `null` for keep the existing setting, which defaults to `0`.
Does not affect `id_full`. | `number` | `null` | no | -| [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper`.
Default value: `title`. | `string` | `null` | no | -| [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | -| [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`. | `string` | `null` | no | -| [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
The value of the `name` tag, if included, will be the `id`, not the `name`.
Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | 
[
  "default"
]
| no | -| [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | -| [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no | -| [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | -| [roles](#input\_roles) | Database roles created in the stage scope | 
map(object({
    enabled                   = optional(bool, true)
    with_grant_option         = optional(bool)
    granted_to_roles          = optional(list(string))
    granted_to_database_roles = optional(list(string))
    granted_database_roles    = optional(list(string))
    stage_grants              = optional(list(string))
    all_privileges            = optional(bool)
  }))
| `{}` | no | +| [name](#input\_name) | Name of the resource | `string` | n/a | yes | +| [name\_scheme](#input\_name\_scheme) | Naming scheme configuration for the resource. This configuration is used to generate names using context provider:
- `properties` - list of properties to use when creating the name - is superseded by `var.context_templates`
- `delimiter` - delimited used to create the name from `properties` - is superseded by `var.context_templates`
- `context_template_name` - name of the context template used to create the name
- `replace_chars_regex` - regex to use for replacing characters in property-values created by the provider - any characters that match the regex will be removed from the name
- `extra_values` - map of extra label-value pairs, used to create a name | 
object({
    properties            = optional(list(string), ["name"])
    delimiter             = optional(string, "_")
    context_template_name = optional(string, "snowflake-stage")
    replace_chars_regex   = optional(string, "[^a-zA-Z0-9_]")
    extra_values          = optional(map(string))
  })
| `{}` | no | +| [roles](#input\_roles) | Database roles created in the stage scope | 
map(object({
    name_scheme = optional(object({
      properties            = optional(list(string))
      delimiter             = optional(string)
      context_template_name = optional(string)
      replace_chars_regex   = optional(string)
      extra_labels          = optional(map(string))
    }))
    comment                   = optional(string)
    with_grant_option         = optional(bool)
    granted_to_roles          = optional(list(string))
    granted_to_database_roles = optional(list(string))
    granted_database_roles    = optional(list(string))
    stage_grants              = optional(list(string))
    all_privileges            = optional(bool)
  }))
| `{}` | no | | [schema](#input\_schema) | The schema in which to create the stage | `string` | n/a | yes | | [snowflake\_iam\_user](#input\_snowflake\_iam\_user) | Specifies the Snowflake IAM user | `string` | `null` | no | -| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | | [stage\_ownership\_grant](#input\_stage\_ownership\_grant) | To which account role the stage ownership should be granted | `string` | `null` | no | | [storage\_integration](#input\_storage\_integration) | Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity | `string` | `null` | no | -| [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | -| [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no | | [url](#input\_url) | Specifies the URL for the stage | `string` | `null` | no | ## Modules @@ -121,30 +136,31 @@ For more information, refer to [variables.tf](variables.tf), list of inputs belo | Name | Source | Version | |------|--------|---------| | [roles\_deep\_merge](#module\_roles\_deep\_merge) | Invicton-Labs/deepmerge/null | 0.1.5 | -| [snowflake\_custom\_role](#module\_snowflake\_custom\_role) | getindata/database-role/snowflake | 1.1.1 | -| [snowflake\_default\_role](#module\_snowflake\_default\_role) | getindata/database-role/snowflake | 1.1.1 | -| [stage\_label](#module\_stage\_label) | cloudposse/label/null | 0.25.0 | -| [this](#module\_this) | cloudposse/label/null | 0.25.0 | +| [snowflake\_custom\_role](#module\_snowflake\_custom\_role) | getindata/database-role/snowflake | 2.0.1 | +| [snowflake\_default\_role](#module\_snowflake\_default\_role) | getindata/database-role/snowflake | 2.0.1 | ## Outputs | Name | Description | |------|-------------| | [database\_roles](#output\_database\_roles) | This stage access roles | +| [fully\_qualified\_name](#output\_fully\_qualified\_name) | Fully Qualified Name of the stage | | [name](#output\_name) | Name of the stage | ## Providers | Name | Version | |------|---------| -| [snowflake](#provider\_snowflake) | ~> 0.90 | +| [context](#provider\_context) | >=0.4.0 | +| [snowflake](#provider\_snowflake) | >= 0.95 | ## Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.3 | -| [snowflake](#requirement\_snowflake) | ~> 0.90 | +| [context](#requirement\_context) | >=0.4.0 | +| [snowflake](#requirement\_snowflake) | >= 0.95 | ## Resources @@ -152,6 +168,7 @@ For more information, refer to [variables.tf](variables.tf), list of inputs belo |------|------| | [snowflake_grant_ownership.stage_ownership](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_ownership) | resource | | [snowflake_stage.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/stage) | resource | +| [context_label.this](https://registry.terraform.io/providers/cloudposse/context/latest/docs/data-sources/label) | data source | ## CONTRIBUTING diff --git a/context.tf b/context.tf deleted file mode 100644 index 5e0ef88..0000000 --- a/context.tf +++ /dev/null @@ -1,279 +0,0 @@ -# -# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label -# All other instances of this file should be a copy of that one -# -# -# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf -# and then place it in your Terraform module to automatically get -# Cloud Posse's standard configuration inputs suitable for passing -# to Cloud Posse modules. -# -# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf -# -# Modules should access the whole context as `module.this.context` -# to get the input variables with nulls for defaults, -# for example `context = module.this.context`, -# and access individual variables as `module.this.`, -# with final values filled in. -# -# For example, when using defaults, `module.this.context.delimiter` -# will be null, and `module.this.delimiter` will be `-` (hyphen). -# - -module "this" { - source = "cloudposse/label/null" - version = "0.25.0" # requires Terraform >= 0.13.0 - - enabled = var.enabled - namespace = var.namespace - tenant = var.tenant - environment = var.environment - stage = var.stage - name = var.name - delimiter = var.delimiter - attributes = var.attributes - tags = var.tags - additional_tag_map = var.additional_tag_map - label_order = var.label_order - regex_replace_chars = var.regex_replace_chars - id_length_limit = var.id_length_limit - label_key_case = var.label_key_case - label_value_case = var.label_value_case - descriptor_formats = var.descriptor_formats - labels_as_tags = var.labels_as_tags - - context = var.context -} - -# Copy contents of cloudposse/terraform-null-label/variables.tf here - -variable "context" { - type = any - default = { - enabled = true - namespace = null - tenant = null - environment = null - stage = null - name = null - delimiter = null - attributes = [] - tags = {} - additional_tag_map = {} - regex_replace_chars = null - label_order = [] - id_length_limit = null - label_key_case = null - label_value_case = null - descriptor_formats = {} - # Note: we have to use [] instead of null for unset lists due to - # https://github.com/hashicorp/terraform/issues/28137 - # which was not fixed until Terraform 1.0.0, - # but we want the default to be all the labels in `label_order` - # and we want users to be able to prevent all tag generation - # by setting `labels_as_tags` to `[]`, so we need - # a different sentinel to indicate "default" - labels_as_tags = ["unset"] - } - description = <<-EOT - Single object for setting entire context at once. - See description of individual variables for details. - Leave string and numeric variables as `null` to use default value. - Individual variable settings (non-null) override settings in context object, - except for attributes, tags, and additional_tag_map, which are merged. - EOT - - validation { - condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) - error_message = "Allowed values: `lower`, `title`, `upper`." - } - - validation { - condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) - error_message = "Allowed values: `lower`, `title`, `upper`, `none`." - } -} - -variable "enabled" { - type = bool - default = null - description = "Set to false to prevent the module from creating any resources" -} - -variable "namespace" { - type = string - default = null - description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique" -} - -variable "tenant" { - type = string - default = null - description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for" -} - -variable "environment" { - type = string - default = null - description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'" -} - -variable "stage" { - type = string - default = null - description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'" -} - -variable "name" { - type = string - default = null - description = <<-EOT - ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. - This is the only ID element not also included as a `tag`. - The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. - EOT -} - -variable "delimiter" { - type = string - default = null - description = <<-EOT - Delimiter to be used between ID elements. - Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. - EOT -} - -variable "attributes" { - type = list(string) - default = [] - description = <<-EOT - ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, - in the order they appear in the list. New attributes are appended to the - end of the list. The elements of the list are joined by the `delimiter` - and treated as a single ID element. - EOT -} - -variable "labels_as_tags" { - type = set(string) - default = ["default"] - description = <<-EOT - Set of labels (ID elements) to include as tags in the `tags` output. - Default is to include all labels. - Tags with empty values will not be included in the `tags` output. - Set to `[]` to suppress all generated tags. - **Notes:** - The value of the `name` tag, if included, will be the `id`, not the `name`. - Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be - changed in later chained modules. Attempts to change it will be silently ignored. - EOT -} - -variable "tags" { - type = map(string) - default = {} - description = <<-EOT - Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). - Neither the tag keys nor the tag values will be modified by this module. - EOT -} - -variable "additional_tag_map" { - type = map(string) - default = {} - description = <<-EOT - Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. - This is for some rare cases where resources want additional configuration of tags - and therefore take a list of maps with tag key, value, and additional configuration. - EOT -} - -variable "label_order" { - type = list(string) - default = null - description = <<-EOT - The order in which the labels (ID elements) appear in the `id`. - Defaults to ["namespace", "environment", "stage", "name", "attributes"]. - You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. - EOT -} - -variable "regex_replace_chars" { - type = string - default = null - description = <<-EOT - Terraform regular expression (regex) string. - Characters matching the regex will be removed from the ID elements. - If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. - EOT -} - -variable "id_length_limit" { - type = number - default = null - description = <<-EOT - Limit `id` to this many characters (minimum 6). - Set to `0` for unlimited length. - Set to `null` for keep the existing setting, which defaults to `0`. - Does not affect `id_full`. - EOT - validation { - condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 - error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." - } -} - -variable "label_key_case" { - type = string - default = null - description = <<-EOT - Controls the letter case of the `tags` keys (label names) for tags generated by this module. - Does not affect keys of tags passed in via the `tags` input. - Possible values: `lower`, `title`, `upper`. - Default value: `title`. - EOT - - validation { - condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) - error_message = "Allowed values: `lower`, `title`, `upper`." - } -} - -variable "label_value_case" { - type = string - default = null - description = <<-EOT - Controls the letter case of ID elements (labels) as included in `id`, - set as tag values, and output by this module individually. - Does not affect values of tags passed in via the `tags` input. - Possible values: `lower`, `title`, `upper` and `none` (no transformation). - Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. - Default value: `lower`. - EOT - - validation { - condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) - error_message = "Allowed values: `lower`, `title`, `upper`, `none`." - } -} - -variable "descriptor_formats" { - type = any - default = {} - description = <<-EOT - Describe additional descriptors to be output in the `descriptors` output map. - Map of maps. Keys are names of descriptors. Values are maps of the form - `{ - format = string - labels = list(string) - }` - (Type is `any` so the map values can later be enhanced to provide additional options.) - `format` is a Terraform format string to be passed to the `format()` function. - `labels` is a list of labels, in order, to pass to `format()` function. - Label values will be normalized before being passed to `format()` so they will be - identical to how they appear in `id`. - Default is `{}` (`descriptors` output will be empty). - EOT -} - -#### End of copy of cloudposse/terraform-null-label/variables.tf diff --git a/examples/complete/README.md b/examples/complete/README.md index 153cdbf..3907496 100644 --- a/examples/complete/README.md +++ b/examples/complete/README.md @@ -34,50 +34,35 @@ terraform destroy -var-file=fixtures.tfvars | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no | -| [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element. | `list(string)` | `[]` | no | -| [context](#input\_context) | Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
| no | -| [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | -| [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
format = string
labels = list(string)
}`
(Type is `any` so the map values can later be enhanced to provide additional options.)
`format` is a Terraform format string to be passed to the `format()` function.
`labels` is a list of labels, in order, to pass to `format()` function.
Label values will be normalized before being passed to `format()` so they will be
identical to how they appear in `id`.
Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no | -| [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | -| [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no | -| [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).
Set to `0` for unlimited length.
Set to `null` for keep the existing setting, which defaults to `0`.
Does not affect `id_full`. | `number` | `null` | no | -| [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper`.
Default value: `title`. | `string` | `null` | no | -| [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | -| [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`. | `string` | `null` | no | -| [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
The value of the `name` tag, if included, will be the `id`, not the `name`.
Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | 
[
  "default"
]
| no | -| [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | -| [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no | -| [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | -| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | -| [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | -| [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no | +| [context\_templates](#input\_context\_templates) | A map of context templates used to generate names | `map(string)` | n/a | yes | ## Modules | Name | Source | Version | |------|--------|---------| -| [internal\_stage](#module\_internal\_stage) | ../../ | n/a | -| [this](#module\_this) | cloudposse/label/null | 0.25.0 | +| [internal\_stage\_1](#module\_internal\_stage\_1) | ../../ | n/a | +| [internal\_stage\_2](#module\_internal\_stage\_2) | ../../ | n/a | ## Outputs | Name | Description | |------|-------------| -| [internal\_stage](#output\_internal\_stage) | Internal stage module outputs | +| [internal\_stage\_1](#output\_internal\_stage\_1) | Internal stage module outputs | +| [internal\_stage\_2](#output\_internal\_stage\_2) | Internal stage module outputs | ## Providers | Name | Version | |------|---------| -| [snowflake](#provider\_snowflake) | ~> 0.90 | +| [snowflake](#provider\_snowflake) | >= 0.95 | ## Requirements | Name | Version | |------|---------| -| [terraform](#requirement\_terraform) | >= 1.3 | -| [snowflake](#requirement\_snowflake) | ~> 0.90 | +| [terraform](#requirement\_terraform) | >= 1.5 | +| [context](#requirement\_context) | >=0.4.0 | +| [snowflake](#requirement\_snowflake) | >= 0.95 | ## Resources diff --git a/examples/complete/context.tf b/examples/complete/context.tf deleted file mode 100644 index 5e0ef88..0000000 --- a/examples/complete/context.tf +++ /dev/null @@ -1,279 +0,0 @@ -# -# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label -# All other instances of this file should be a copy of that one -# -# -# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf -# and then place it in your Terraform module to automatically get -# Cloud Posse's standard configuration inputs suitable for passing -# to Cloud Posse modules. -# -# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf -# -# Modules should access the whole context as `module.this.context` -# to get the input variables with nulls for defaults, -# for example `context = module.this.context`, -# and access individual variables as `module.this.`, -# with final values filled in. -# -# For example, when using defaults, `module.this.context.delimiter` -# will be null, and `module.this.delimiter` will be `-` (hyphen). -# - -module "this" { - source = "cloudposse/label/null" - version = "0.25.0" # requires Terraform >= 0.13.0 - - enabled = var.enabled - namespace = var.namespace - tenant = var.tenant - environment = var.environment - stage = var.stage - name = var.name - delimiter = var.delimiter - attributes = var.attributes - tags = var.tags - additional_tag_map = var.additional_tag_map - label_order = var.label_order - regex_replace_chars = var.regex_replace_chars - id_length_limit = var.id_length_limit - label_key_case = var.label_key_case - label_value_case = var.label_value_case - descriptor_formats = var.descriptor_formats - labels_as_tags = var.labels_as_tags - - context = var.context -} - -# Copy contents of cloudposse/terraform-null-label/variables.tf here - -variable "context" { - type = any - default = { - enabled = true - namespace = null - tenant = null - environment = null - stage = null - name = null - delimiter = null - attributes = [] - tags = {} - additional_tag_map = {} - regex_replace_chars = null - label_order = [] - id_length_limit = null - label_key_case = null - label_value_case = null - descriptor_formats = {} - # Note: we have to use [] instead of null for unset lists due to - # https://github.com/hashicorp/terraform/issues/28137 - # which was not fixed until Terraform 1.0.0, - # but we want the default to be all the labels in `label_order` - # and we want users to be able to prevent all tag generation - # by setting `labels_as_tags` to `[]`, so we need - # a different sentinel to indicate "default" - labels_as_tags = ["unset"] - } - description = <<-EOT - Single object for setting entire context at once. - See description of individual variables for details. - Leave string and numeric variables as `null` to use default value. - Individual variable settings (non-null) override settings in context object, - except for attributes, tags, and additional_tag_map, which are merged. - EOT - - validation { - condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) - error_message = "Allowed values: `lower`, `title`, `upper`." - } - - validation { - condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) - error_message = "Allowed values: `lower`, `title`, `upper`, `none`." - } -} - -variable "enabled" { - type = bool - default = null - description = "Set to false to prevent the module from creating any resources" -} - -variable "namespace" { - type = string - default = null - description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique" -} - -variable "tenant" { - type = string - default = null - description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for" -} - -variable "environment" { - type = string - default = null - description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'" -} - -variable "stage" { - type = string - default = null - description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'" -} - -variable "name" { - type = string - default = null - description = <<-EOT - ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. - This is the only ID element not also included as a `tag`. - The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. - EOT -} - -variable "delimiter" { - type = string - default = null - description = <<-EOT - Delimiter to be used between ID elements. - Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. - EOT -} - -variable "attributes" { - type = list(string) - default = [] - description = <<-EOT - ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, - in the order they appear in the list. New attributes are appended to the - end of the list. The elements of the list are joined by the `delimiter` - and treated as a single ID element. - EOT -} - -variable "labels_as_tags" { - type = set(string) - default = ["default"] - description = <<-EOT - Set of labels (ID elements) to include as tags in the `tags` output. - Default is to include all labels. - Tags with empty values will not be included in the `tags` output. - Set to `[]` to suppress all generated tags. - **Notes:** - The value of the `name` tag, if included, will be the `id`, not the `name`. - Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be - changed in later chained modules. Attempts to change it will be silently ignored. - EOT -} - -variable "tags" { - type = map(string) - default = {} - description = <<-EOT - Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). - Neither the tag keys nor the tag values will be modified by this module. - EOT -} - -variable "additional_tag_map" { - type = map(string) - default = {} - description = <<-EOT - Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. - This is for some rare cases where resources want additional configuration of tags - and therefore take a list of maps with tag key, value, and additional configuration. - EOT -} - -variable "label_order" { - type = list(string) - default = null - description = <<-EOT - The order in which the labels (ID elements) appear in the `id`. - Defaults to ["namespace", "environment", "stage", "name", "attributes"]. - You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. - EOT -} - -variable "regex_replace_chars" { - type = string - default = null - description = <<-EOT - Terraform regular expression (regex) string. - Characters matching the regex will be removed from the ID elements. - If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. - EOT -} - -variable "id_length_limit" { - type = number - default = null - description = <<-EOT - Limit `id` to this many characters (minimum 6). - Set to `0` for unlimited length. - Set to `null` for keep the existing setting, which defaults to `0`. - Does not affect `id_full`. - EOT - validation { - condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 - error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." - } -} - -variable "label_key_case" { - type = string - default = null - description = <<-EOT - Controls the letter case of the `tags` keys (label names) for tags generated by this module. - Does not affect keys of tags passed in via the `tags` input. - Possible values: `lower`, `title`, `upper`. - Default value: `title`. - EOT - - validation { - condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) - error_message = "Allowed values: `lower`, `title`, `upper`." - } -} - -variable "label_value_case" { - type = string - default = null - description = <<-EOT - Controls the letter case of ID elements (labels) as included in `id`, - set as tag values, and output by this module individually. - Does not affect values of tags passed in via the `tags` input. - Possible values: `lower`, `title`, `upper` and `none` (no transformation). - Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. - Default value: `lower`. - EOT - - validation { - condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) - error_message = "Allowed values: `lower`, `title`, `upper`, `none`." - } -} - -variable "descriptor_formats" { - type = any - default = {} - description = <<-EOT - Describe additional descriptors to be output in the `descriptors` output map. - Map of maps. Keys are names of descriptors. Values are maps of the form - `{ - format = string - labels = list(string) - }` - (Type is `any` so the map values can later be enhanced to provide additional options.) - `format` is a Terraform format string to be passed to the `format()` function. - `labels` is a list of labels, in order, to pass to `format()` function. - Label values will be normalized before being passed to `format()` so they will be - identical to how they appear in `id`. - Default is `{}` (`descriptors` output will be empty). - EOT -} - -#### End of copy of cloudposse/terraform-null-label/variables.tf diff --git a/examples/complete/fixtures.tfvars b/examples/complete/fixtures.tfvars index 5c706f7..988c594 100644 --- a/examples/complete/fixtures.tfvars +++ b/examples/complete/fixtures.tfvars @@ -1,22 +1,5 @@ -descriptor_formats = { - snowflake-role = { - labels = ["attributes", "name"] - format = "%v_%v" - } - snowflake-database = { - labels = ["environment", "name", "attributes"] - format = "%v_%v_%v" - } - snowflake-schema = { - labels = ["name", "attributes"] - format = "%v_%v" - } - snowflake-stage = { - labels = ["name", "attributes"] - format = "%v_%v" - } -} - -tags = { - Terraform = "True" +context_templates = { + snowflake-stage = "{{.name}}" + snowflake-project-stage = "{{.project}}_{{.name}}" + snowflake-stage-database-role = "{{.schema}}_{{.stage}}_{{.suffix}}_{{.name}}" } diff --git a/examples/complete/main.tf b/examples/complete/main.tf index bd56a48..570202e 100644 --- a/examples/complete/main.tf +++ b/examples/complete/main.tf @@ -26,9 +26,10 @@ resource "snowflake_database_role" "db_role_3" { name = "DB_ROLE_3" } -module "internal_stage" { - source = "../../" - context = module.this.context +module "internal_stage_1" { + source = "../../" + + context_templates = var.context_templates name = "INGEST" schema = snowflake_schema.this.name @@ -54,9 +55,6 @@ module "internal_stage" { "${snowflake_database.this.name}.${snowflake_database_role.db_role_2.name}", ] } - readwrite = { - enabled = false # Disables readwrite default database role creation - } role_1 = { # Database role created by user input granted_to_roles = [snowflake_account_role.role_1.name] granted_to_database_roles = ["${snowflake_database.this.name}.${snowflake_database_role.db_role_3.name}"] @@ -71,9 +69,24 @@ module "internal_stage" { with_grant_option = false on_future = true on_all = false - enabled = false } } stage_ownership_grant = snowflake_account_role.role_1.name } + +module "internal_stage_2" { + source = "../../" + + #context_templates = var.context_templates + name = "stage_2" + name_scheme = { + context_template_name = "snowflake-project-stage" + extra_values = { + project = "project" + } + } + + schema = snowflake_schema.this.name + database = snowflake_database.this.name +} diff --git a/examples/complete/outputs.tf b/examples/complete/outputs.tf index a368e6c..f92df70 100644 --- a/examples/complete/outputs.tf +++ b/examples/complete/outputs.tf @@ -1,4 +1,9 @@ -output "internal_stage" { +output "internal_stage_1" { description = "Internal stage module outputs" - value = module.internal_stage + value = module.internal_stage_1 +} + +output "internal_stage_2" { + description = "Internal stage module outputs" + value = module.internal_stage_2 } diff --git a/examples/complete/providers.tf b/examples/complete/providers.tf index d343f0d..5b943b9 100644 --- a/examples/complete/providers.tf +++ b/examples/complete/providers.tf @@ -1 +1,12 @@ provider "snowflake" {} + +provider "context" { + properties = { + "environment" = {} + "name" = { required = true } + } + + values = { + environment = "dev" + } +} diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf new file mode 100644 index 0000000..f09a47d --- /dev/null +++ b/examples/complete/variables.tf @@ -0,0 +1,4 @@ +variable "context_templates" { + description = "A map of context templates used to generate names" + type = map(string) +} diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf index 33afd12..0c16dd3 100644 --- a/examples/complete/versions.tf +++ b/examples/complete/versions.tf @@ -1,9 +1,13 @@ terraform { - required_version = ">= 1.3" + required_version = ">= 1.5" required_providers { snowflake = { source = "Snowflake-Labs/snowflake" - version = "~> 0.90" + version = ">= 0.95" + } + context = { + source = "cloudposse/context" + version = ">=0.4.0" } } } diff --git a/examples/simple/README.md b/examples/simple/README.md index 93b6890..f90226f 100644 --- a/examples/simple/README.md +++ b/examples/simple/README.md @@ -47,14 +47,14 @@ No inputs. | Name | Version | |------|---------| -| [snowflake](#provider\_snowflake) | ~> 0.90 | +| [snowflake](#provider\_snowflake) | ~> 0.95 | ## Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.3 | -| [snowflake](#requirement\_snowflake) | ~> 0.90 | +| [snowflake](#requirement\_snowflake) | ~> 0.95 | ## Resources diff --git a/examples/simple/versions.tf b/examples/simple/versions.tf index 33afd12..0929444 100644 --- a/examples/simple/versions.tf +++ b/examples/simple/versions.tf @@ -3,7 +3,7 @@ terraform { required_providers { snowflake = { source = "Snowflake-Labs/snowflake" - version = "~> 0.90" + version = "~> 0.95" } } } diff --git a/locals.tf b/locals.tf index f89b2e3..7af8719 100644 --- a/locals.tf +++ b/locals.tf @@ -1,12 +1,15 @@ locals { - # Get a name from the descriptor. If not available, use default naming convention. - # Trim and replace function are used to avoid bare delimiters on both ends of the name and situation of adjacent delimiters. - name_from_descriptor = module.stage_label.enabled ? trim(replace( - lookup(module.stage_label.descriptors, var.descriptor_name, module.stage_label.id), "/${module.stage_label.delimiter}${module.stage_label.delimiter}+/", module.stage_label.delimiter - ), module.stage_label.delimiter) : null - - create_default_roles = module.this.enabled && var.create_default_roles - schema_object_stage_name = module.this.enabled ? "\"${one(snowflake_stage.this[*].database)}\".\"${one(snowflake_stage.this[*].schema)}\".\"${one(snowflake_stage.this[*].name)}\"" : null + context_template = lookup(var.context_templates, var.name_scheme.context_template_name, null) + + default_role_naming_scheme = { + properties = ["schema", "stage", "suffix", "name"] + context_template_name = "snowflake-stage-database-role" + extra_values = { + stage = var.name + schema = var.schema + suffix = "stg" + } + } is_internal = var.url == null @@ -26,7 +29,7 @@ locals { default_roles = { for role_name, role in local.roles_definition : role_name => role - if contains(keys(local.default_roles_definition), role_name) + if contains(keys(local.default_roles_definition), role_name) && var.create_default_roles } custom_roles = { diff --git a/main.tf b/main.tf index e9153af..859682a 100644 --- a/main.tf +++ b/main.tf @@ -1,17 +1,18 @@ -module "stage_label" { - source = "cloudposse/label/null" - version = "0.25.0" - context = module.this.context - - delimiter = coalesce(module.this.context.delimiter, "_") - regex_replace_chars = coalesce(module.this.context.regex_replace_chars, "/[^_a-zA-Z0-9]/") - label_value_case = coalesce(module.this.context.label_value_case, "upper") +data "context_label" "this" { + delimiter = local.context_template == null ? var.name_scheme.delimiter : null + properties = local.context_template == null ? var.name_scheme.properties : null + template = local.context_template + + replace_chars_regex = var.name_scheme.replace_chars_regex + + values = merge( + var.name_scheme.extra_values, + { name = var.name } + ) } resource "snowflake_stage" "this" { - count = module.this.enabled ? 1 : 0 - - name = local.name_from_descriptor + name = data.context_label.this.rendered database = var.database schema = var.schema @@ -26,27 +27,42 @@ resource "snowflake_stage" "this" { storage_integration = var.storage_integration url = var.url } +moved { + from = snowflake_stage.this[0] + to = snowflake_stage.this +} + +resource "snowflake_grant_ownership" "stage_ownership" { + count = var.stage_ownership_grant != null ? 1 : 0 + + account_role_name = var.stage_ownership_grant + outbound_privileges = "REVOKE" + on { + object_type = "STAGE" + object_name = snowflake_stage.this.fully_qualified_name + } +} module "snowflake_default_role" { for_each = local.default_roles source = "getindata/database-role/snowflake" - version = "1.1.1" - context = module.this.context - enabled = local.create_default_roles && lookup(each.value, "enabled", true) + version = "2.0.1" - database_name = one(snowflake_stage.this[*].database) - name = each.key + database_name = snowflake_stage.this.database + context_templates = var.context_templates + + name = each.key + name_scheme = merge( + local.default_role_naming_scheme, + lookup(each.value, "name_scheme", {}) + ) + comment = lookup(each.value, "comment", null) granted_to_roles = lookup(each.value, "granted_to_roles", []) granted_to_database_roles = lookup(each.value, "granted_to_database_roles", []) granted_database_roles = lookup(each.value, "granted_database_roles", []) - attributes = [ - one(snowflake_stage.this[*].schema), - one(snowflake_stage.this[*].name) - ] - schema_objects_grants = { "STAGE" = [ { @@ -55,61 +71,44 @@ module "snowflake_default_role" { with_grant_option = lookup(each.value, "with_grant_option", false) on_future = lookup(each.value, "on_future", false) on_all = lookup(each.value, "on_all", false) - object_name = (lookup(each.value, "on_future", false) || lookup(each.value, "on_all", false)) ? null : one(snowflake_stage.this[*].name) - schema_name = one(snowflake_stage.this[*].schema) + object_name = (lookup(each.value, "on_future", false) || lookup(each.value, "on_all", false)) ? null : snowflake_stage.this.name + schema_name = snowflake_stage.this.schema } ] } - - depends_on = [ - snowflake_stage.this - ] -} - -resource "snowflake_grant_ownership" "stage_ownership" { - count = var.stage_ownership_grant != null ? 1 : 0 - - account_role_name = var.stage_ownership_grant - outbound_privileges = "REVOKE" - on { - object_type = "STAGE" - object_name = local.schema_object_stage_name - } } module "snowflake_custom_role" { for_each = local.custom_roles source = "getindata/database-role/snowflake" - version = "1.1.1" - context = module.this.context - enabled = module.this.enabled && lookup(each.value, "enabled", true) + version = "2.0.1" + + database_name = snowflake_stage.this.database + context_templates = var.context_templates - database_name = one(snowflake_stage.this[*].database) - name = each.key + name = each.key + name_scheme = merge( + local.default_role_naming_scheme, + lookup(each.value, "name_scheme", {}) + ) + comment = lookup(each.value, "comment", null) granted_to_roles = lookup(each.value, "granted_to_roles", []) granted_to_database_roles = lookup(each.value, "granted_to_database_roles", []) granted_database_roles = lookup(each.value, "granted_database_roles", []) - attributes = [ - one(snowflake_stage.this[*].schema), - one(snowflake_stage.this[*].name) - ] - schema_objects_grants = { "STAGE" = [ { privileges = lookup(each.value, "stage_grants", null) all_privileges = lookup(each.value, "all_privileges", null) with_grant_option = lookup(each.value, "with_grant_option", false) - object_name = (lookup(each.value, "on_future", false) || lookup(each.value, "on_all", false)) ? null : one(snowflake_stage.this[*].name) - schema_name = one(snowflake_stage.this[*].schema) + on_future = lookup(each.value, "on_future", false) + on_all = lookup(each.value, "on_all", false) + object_name = (lookup(each.value, "on_future", false) || lookup(each.value, "on_all", false)) ? null : snowflake_stage.this.name + schema_name = snowflake_stage.this.schema } ] } - - depends_on = [ - snowflake_stage.this - ] } diff --git a/outputs.tf b/outputs.tf index 7d65885..0c6210b 100644 --- a/outputs.tf +++ b/outputs.tf @@ -1,6 +1,11 @@ output "name" { description = "Name of the stage" - value = one(snowflake_stage.this[*].name) + value = snowflake_stage.this.name +} + +output "fully_qualified_name" { + description = "Fully Qualified Name of the stage" + value = snowflake_stage.this.fully_qualified_name } output "database_roles" { diff --git a/variables.tf b/variables.tf index 99c6ea1..c28f44b 100644 --- a/variables.tf +++ b/variables.tf @@ -1,7 +1,6 @@ -variable "descriptor_name" { - description = "Name of the descriptor used to form a resource name" +variable "name" { + description = "Name of the resource" type = string - default = "snowflake-stage" } variable "database" { @@ -83,7 +82,14 @@ variable "create_default_roles" { variable "roles" { description = "Database roles created in the stage scope" type = map(object({ - enabled = optional(bool, true) + name_scheme = optional(object({ + properties = optional(list(string)) + delimiter = optional(string) + context_template_name = optional(string) + replace_chars_regex = optional(string) + extra_labels = optional(map(string)) + })) + comment = optional(string) with_grant_option = optional(bool) granted_to_roles = optional(list(string)) granted_to_database_roles = optional(list(string)) @@ -99,3 +105,28 @@ variable "stage_ownership_grant" { type = string default = null } + +variable "name_scheme" { + description = < Date: Tue, 5 Nov 2024 15:24:04 +0100 Subject: [PATCH 2/4] chore: fix typo --- locals.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locals.tf b/locals.tf index 7af8719..059e8cb 100644 --- a/locals.tf +++ b/locals.tf @@ -49,7 +49,7 @@ locals { module.snowflake_default_role, module.snowflake_custom_role ) : role_name => role - if role.name != null + if role_name != null } } From 39432b5de6b7cd3253c704dcdc02d1ccb1a09409 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Gniewek-W=C4=99grzyn?= <47598580+dgniewek@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:36:19 +0100 Subject: [PATCH 3/4] chore: chage versions Co-authored-by: Piotr Mossakowski --- examples/simple/versions.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/simple/versions.tf b/examples/simple/versions.tf index 0929444..659976c 100644 --- a/examples/simple/versions.tf +++ b/examples/simple/versions.tf @@ -3,7 +3,7 @@ terraform { required_providers { snowflake = { source = "Snowflake-Labs/snowflake" - version = "~> 0.95" + version = ">= 0.95" } } } From 5a8ebf732a39e3b6f0ad8e24194b6efc86fb7a9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Gniewek-W=C4=99grzyn?= Date: Tue, 5 Nov 2024 15:37:11 +0100 Subject: [PATCH 4/4] docs: update README --- examples/simple/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/simple/README.md b/examples/simple/README.md index f90226f..95a65b0 100644 --- a/examples/simple/README.md +++ b/examples/simple/README.md @@ -47,14 +47,14 @@ No inputs. | Name | Version | |------|---------| -| [snowflake](#provider\_snowflake) | ~> 0.95 | +| [snowflake](#provider\_snowflake) | >= 0.95 | ## Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.3 | -| [snowflake](#requirement\_snowflake) | ~> 0.95 | +| [snowflake](#requirement\_snowflake) | >= 0.95 | ## Resources