cloud-foundation-fabric/modules/bigtable-instance
Julio Castillo 1d13e3e624 Add more validations to linter
- Ensure all variables and outputs are sorted
- Ensure all variables and outputs have a description
- Add data-solutions/data-platform-foundations to linter

Fix all modules to follow these new conventions.
2021-10-08 18:26:04 +02:00
..
README.md Make examples in READMEs runnable and testable 2020-11-07 10:28:33 +01:00
main.tf Update CI processes (#296) 2021-08-12 17:30:53 +02:00
outputs.tf Add more validations to linter 2021-10-08 18:26:04 +02:00
variables.tf Add more validations to linter 2021-10-08 18:26:04 +02:00
versions.tf Update copyright to 2021 2021-02-15 09:38:10 +01:00

README.md

Google Cloud BigTable Module

This module allows managing a single BigTable instance, including access configuration and tables.

TODO

  • support bigtable_gc_policy
  • support bigtable_app_profile

Examples

Simple instance with access configuration


module "bigtable-instance" {
  source               = "./modules/bigtable-instance"
  project_id           = "my-project"
  name                 = "instance"
  cluster_id           = "instance"
  zone                 = "europe-west1-b"
  tables               = {
    test1 = null,
    test2 = {
      split_keys    = ["a", "b", "c"]
      column_family = null
    }
  }
  iam       = {
    "roles/bigtable.user" = ["user:viewer@testdomain.com"]
  }
}
# tftest:modules=1:resources=4

Variables

name description type required default
name The name of the Cloud Bigtable instance. string
project_id Id of the project where datasets will be created. string
zone The zone to create the Cloud Bigtable cluster in. string
cluster_id The ID of the Cloud Bigtable cluster. string europe-west1
deletion_protection Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. true
display_name The human-readable display name of the Bigtable instance. null
iam IAM bindings for topic in {ROLE => [MEMBERS]} format. map(list(string)) {}
instance_type (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. string null
num_nodes The number of nodes in your Cloud Bigtable cluster. number 1
storage_type The storage type to use. string SSD
table_options_defaults Default option of tables created in the BigTable instance. object({...}) ...
tables Tables to be created in the BigTable instance, options can be null. map(object({...})) {}

Outputs

name description sensitive
id An identifier for the resource with format projects/{{project}}/instances/{{name}}.
instance BigTable intance.
table_ids Map of fully qualified table ids keyed by table name.
tables Table resources.