/terraform-ibm-icd-etcd

Implements an instance of IBM Cloud Databases for etcd.

Primary LanguageHCLApache License 2.0Apache-2.0

IBM Cloud Databases for etcd module

Graduated (Supported) semantic-release pre-commit latest release Renovate enabled

This module implements an instance of the IBM Cloud Databases for etcd service.

❗ The module does not support major version upgrades or updates to disk encryption and backup encryption keys. To upgrade the version, create another instance of Databases for etcd with the updated version.

❗ The module only supports setting the disk encryption and backup encryption key CRNs on creation and no update support is available. The KMS manual or automatic key rotation may be used to change the key value and initiate the re-encryption of the deployment.

Overview

terraform-ibm-icd-etcd

Usage

IBM Cloud Databases supports:

If you enable key management encryption and no value is passed for 'backup_encryption_key_crn', the value of 'kms_key_crn' is used

provider "ibm" {
  ibmcloud_api_key = "XXXXXXXXXX" # pragma: allowlist secret
  region           = "us-south"
}

module "ectd_db" {
  source            = "terraform-ibm-modules/icd-etcd/ibm"
  version           = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
  resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX"
  name              = "my-etcd-instance"
  region            = "us-south"
}

Required IAM access policies

You need the following permissions to run this module.

  • Account Management
    • Databases for etcd service
      • Editor role access

Requirements

Name Version
terraform >= 1.3.0
ibm >= 1.65.0, <2.0.0
time >= 0.9.1

Modules

Name Source Version
cbr_rule terraform-ibm-modules/cbr/ibm//modules/cbr-rule-module 1.23.5

Resources

Name Type
ibm_database.etcd_db resource
ibm_iam_authorization_policy.policy resource
ibm_resource_key.service_credentials resource
ibm_resource_tag.etcd_tag resource
time_sleep.wait_for_authorization_policy resource
ibm_database_connection.database_connection data source

Inputs

Name Description Type Default Required
access_tags A list of access tags to apply to the etcd db instance created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details list(string) [] no
admin_pass The password for the database administrator. If the admin password is null then the admin user ID cannot be accessed. More users can be specified in a user block. string null no
auto_scaling Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-etcd?topic=databases-for-etcd-autoscaling in the IBM Cloud Docs. 
object({
    disk = object({
      capacity_enabled             = optional(bool, false)
      free_space_less_than_percent = optional(number, 10)
      io_above_percent             = optional(number, 90)
      io_enabled                   = optional(bool, false)
      io_over_period               = optional(string, "15m")
      rate_increase_percent        = optional(number, 10)
      rate_limit_mb_per_member     = optional(number, 3670016)
      rate_period_seconds          = optional(number, 900)
      rate_units                   = optional(string, "mb")
    })
    memory = object({
      io_above_percent         = optional(number, 90)
      io_enabled               = optional(bool, false)
      io_over_period           = optional(string, "15m")
      rate_increase_percent    = optional(number, 10)
      rate_limit_mb_per_member = optional(number, 114688)
      rate_period_seconds      = optional(number, 900)
      rate_units               = optional(string, "mb")
    })
  })
 null no
backup_crn The CRN of a backup resource to restore from. The backup is created by a database deployment with the same service ID. The backup is loaded after provisioning and the new deployment starts up that uses that data. A backup CRN is in the format crn:v1:<…>:backup:. If omitted, the database is provisioned empty. string null no
backup_encryption_key_crn The CRN of a KMS (Key Protect or Hyper Protect Crypto Services) key to use for encrypting the disk that holds deployment backups. Only used if var.kms_encryption_enabled is set to true. There are limitation per region on the type of KMS service (Key Protect or Hyper Protect Crypto Services) and region for those services. See https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect&interface=ui#key-byok and https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs#use-hpcs-backups string null no
cbr_rules (Optional, list) List of CBR rules to create 
list(object({
    description = string
    account_id  = string
    rule_contexts = list(object({
      attributes = optional(list(object({
        name  = string
        value = string
    }))) }))
    enforcement_mode = string
  }))
 [] no
etcd_version Version of the etcd instance to provision. If no value passed, the current ICD preferred version is used. string null no
existing_kms_instance_guid The GUID of the Hyper Protect Crypto Services or Key Protect instance in which the key specified in var.kms_key_crn and var.backup_encryption_key_crn is coming from. Only required if var.kms_encryption_enabled is 'true', var.skip_iam_authorization_policy is 'false', and passing a value for var.kms_key_crn and/or var.backup_encryption_key_crn or both. string null no
kms_encryption_enabled Set this to true to control the encryption keys used to encrypt the data that you store in IBM Cloud® Databases. If set to false, the data is encrypted by using randomly generated keys. For more info on Key Protect integration, see https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect. For more info on HPCS integration, see https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs bool false no
kms_key_crn The root key CRN of a Key Management Services like Key Protect or Hyper Protect Crypto Services (HPCS) to use for disk encryption. Only used if var.kms_encryption_enabled is set to true. string null no
member_cpu_count Allocated dedicated CPU per-member. For shared CPU, set to 0. Learn more number 0 no
member_disk_mb Allocated memory per-member. Learn more number 20480 no
member_host_flavor Allocated host flavor per member. Learn more. string null no
member_memory_mb Allocated memory per-member. Learn more number 4096 no
members Allocated number of members. Members can be scaled up but not down. number 3 no
name The name given to the etcd instance. string n/a yes
region The region where you want to deploy your instance. string "us-south" no
resource_group_id The resource group ID where the etcd instance will be created. string n/a yes
service_credential_names Map of name, role for service credentials that you want to create for the database map(string) {} no
service_endpoints Specify whether you want to enable the public, private, or both service endpoints. Supported values are 'public', 'private', or 'public-and-private'. string "private" no
skip_iam_authorization_policy Set to true to skip the creation of an IAM authorization policy that permits all etcd database instances in the given resource group to read the encryption key from the Hyper Protect or Key Protect instance passed in var.existing_kms_instance_guid. If set to 'false', a value must be passed for var.existing_kms_instance_guid. In addition, no policy is created if var.kms_encryption_enabled is 'false'. bool false no
tags Optional list of tags to be added to the etcd instance. list(any) [] no
use_default_backup_encryption_key Set to true to use default ICD randomly generated keys. bool false no
users A list of users that you want to create on the database. Multiple blocks are allowed. The user password must be in the range of 10-32 characters. Be warned that in most case using IAM service credentials (via the var.service_credential_names) is sufficient to control access to the etcd instance. This blocks creates native etcd database users, more info on that can be found here https://cloud.ibm.com/docs/databases-for-etcd?topic=databases-for-etcd-user-management 
list(object({
    name     = string
    password = string # pragma: allowlist secret
    type     = string # "type" is required to generate the connection string for the outputs.
    role     = optional(string)
  }))
 [] no

Outputs

Name Description
adminuser Database admin user name
cbr_rule_ids CBR rule ids created to restrict etcd
certificate_base64 Database connection certificate
crn etcd instance crn
guid etcd instance guid
hostname Database connection hostname
id etcd instance id
port Database connection port
service_credentials_json Service credentials json map
service_credentials_object Service credentials object
version etcd instance version

Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See Report an issue or request a feature.

To set up your local development environment, see Local development setup in the project documentation.