Skip to content

Commit cbb101f

Browse files
authored
fix: updated the admin_pass variable description since admin password length requirement has change to a minimum of 15 characters (#52)
1 parent fbfaa93 commit cbb101f

File tree

6 files changed

+11
-9
lines changed

6 files changed

+11
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ You need the following permissions to run this module.
8282
| Name | Description | Type | Default | Required |
8383
|------|-------------|------|---------|:--------:|
8484
| <a name="input_access_tags"></a> [access\_tags](#input\_access\_tags) | A list of access tags to apply to the Elasticsearch instance created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details | `list(string)` | `[]` | no |
85-
| <a name="input_admin_pass"></a> [admin\_pass](#input\_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. The admin password must be in the range of 10-32 characters and cannot start with a special character. | `string` | `null` | no |
85+
| <a name="input_admin_pass"></a> [admin\_pass](#input\_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 |
8686
| <a name="input_auto_scaling"></a> [auto\_scaling](#input\_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-elasticsearch?topic=databases-for-elasticsearch-autoscaling in the IBM Cloud Docs. | <pre>object({<br> disk = object({<br> capacity_enabled = optional(bool, false)<br> free_space_less_than_percent = optional(number, 10)<br> io_above_percent = optional(number, 90)<br> io_enabled = optional(bool, false)<br> io_over_period = optional(string, "15m")<br> rate_increase_percent = optional(number, 10)<br> rate_limit_mb_per_member = optional(number, 3670016)<br> rate_period_seconds = optional(number, 900)<br> rate_units = optional(string, "mb")<br> })<br> memory = object({<br> io_above_percent = optional(number, 90)<br> io_enabled = optional(bool, false)<br> io_over_period = optional(string, "15m")<br> rate_increase_percent = optional(number, 10)<br> rate_limit_mb_per_member = optional(number, 114688)<br> rate_period_seconds = optional(number, 900)<br> rate_units = optional(string, "mb")<br> })<br> })</pre> | `null` | no |
8787
| <a name="input_backup_encryption_key_crn"></a> [backup\_encryption\_key\_crn](#input\_backup\_encryption\_key\_crn) | The CRN of a Key Protect key, that you want to use for encrypting disk that holds deployment backups. Only used if var.kms\_encryption\_enabled is set to true. If no value is passed here, the value passed for the 'kms\_key\_crn' variable is used, unless 'use\_default\_backup\_encryption\_key' is set to 'true'. BYOK for backups is available only in US regions us-south and us-east, and eu-de. Only keys in the us-south and eu-de are durable to region failures. To ensure that your backups are available even if a region failure occurs, you must use a key from us-south or eu-de. Take note that Hyper Protect Crypto Services for IBM Cloud® Databases backups is not currently supported, so if no value is passed here, but a HPCS value is passed for var.kms\_key\_crn, databases backup encryption will use the default encryption keys. | `string` | `null` | no |
8888
| <a name="input_cbr_rules"></a> [cbr\_rules](#input\_cbr\_rules) | (Optional, list) List of CBR rules to create | <pre>list(object({<br> description = string<br> account_id = string<br> rule_contexts = list(object({<br> attributes = optional(list(object({<br> name = string<br> value = string<br> }))) }))<br> enforcement_mode = string<br> }))</pre> | `[]` | no |

examples/complete/main.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ resource "elasticsearch_index" "test" {
6464
name = "terraform-test"
6565
number_of_shards = 1
6666
number_of_replicas = 1
67+
force_destroy = true
6768
}
6869

6970
resource "elasticsearch_cluster_settings" "global" {

examples/complete/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ variable "admin_pass" {
7373
type = string
7474
default = null
7575
sensitive = true
76-
description = "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. The admin password must be in the range of 10-32 characters and cannot start with a special character."
76+
description = "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."
7777
}
7878

7979
variable "users" {

tests/other_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ package test
44
import (
55
"crypto/rand"
66
"encoding/base64"
7-
"github.com/gruntwork-io/terratest/modules/terraform"
87
"testing"
98

9+
"github.com/gruntwork-io/terratest/modules/terraform"
10+
1011
"github.com/stretchr/testify/assert"
1112
"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/testhelper"
1213
)
@@ -31,8 +32,8 @@ func TestRunCompleteExampleOtherVersion(t *testing.T) {
3132
t.Parallel()
3233

3334
// Generate a 15 char long random string for the admin_pass
34-
randomBytes := make([]byte, 12)
35-
_, err := rand.Read(randomBytes)
35+
randomBytes := make([]byte, 13)
36+
rand.Read(randomBytes)
3637
randomPass := "A1" + base64.URLEncoding.EncodeToString(randomBytes)[:13]
3738

3839
options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{

tests/pr_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Tests in this file are run in the PR pipeline
1+
// Tests in this file are run in the PR pipeline.
22
package test
33

44
import (
@@ -43,8 +43,8 @@ func TestRunCompleteExample(t *testing.T) {
4343
t.Parallel()
4444

4545
// Generate a 15 char long random string for the admin_pass
46-
randomBytes := make([]byte, 12)
47-
_, err := rand.Read(randomBytes)
46+
randomBytes := make([]byte, 13)
47+
rand.Read(randomBytes)
4848
randomPass := "A1" + base64.URLEncoding.EncodeToString(randomBytes)[:13]
4949

5050
options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ variable "member_disk_mb" {
100100

101101
variable "admin_pass" {
102102
type = string
103-
description = "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. The admin password must be in the range of 10-32 characters and cannot start with a special character."
103+
description = "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."
104104
default = null
105105
sensitive = true
106106
}

0 commit comments

Comments
 (0)