From 940c10f5e7235c03b1a758aedef2ac7c6b5832d2 Mon Sep 17 00:00:00 2001 From: John Sharpe Date: Thu, 13 Jun 2024 13:54:05 +0100 Subject: [PATCH] Doc updates (#525) --- docs/data-sources/rediscloud_active_active_subscription.md | 7 ------- docs/guides/migration-guide-v1.0.0.md | 1 - docs/resources/rediscloud_active_active_subscription.md | 4 ++-- .../rediscloud_active_active_subscription_database.md | 2 +- docs/resources/rediscloud_essentials_database.md | 2 +- docs/resources/rediscloud_essentials_subscription.md | 2 +- docs/resources/rediscloud_subscription.md | 4 ++-- docs/resources/rediscloud_subscription_database.md | 2 +- 8 files changed, 8 insertions(+), 16 deletions(-) diff --git a/docs/data-sources/rediscloud_active_active_subscription.md b/docs/data-sources/rediscloud_active_active_subscription.md index 93a52f4f..6513e4a3 100644 --- a/docs/data-sources/rediscloud_active_active_subscription.md +++ b/docs/data-sources/rediscloud_active_active_subscription.md @@ -1,10 +1,3 @@ ---- -layout: "rediscloud" -page_title: "Redis Cloud: rediscloud_active_active_subscription" -description: |- - Active Active Subscription data source in the Redis Cloud Terraform provider. ---- - # Resource: rediscloud_active_active_subscription This data source allows access to the details of an existing subscription within your Redis Enterprise Cloud account. diff --git a/docs/guides/migration-guide-v1.0.0.md b/docs/guides/migration-guide-v1.0.0.md index 6d089c46..aafe5c98 100644 --- a/docs/guides/migration-guide-v1.0.0.md +++ b/docs/guides/migration-guide-v1.0.0.md @@ -1,6 +1,5 @@ --- page_title: "Migrating to version v1.X.X" -subcategory: "Guides" --- # Migrating to version v1.X.X diff --git a/docs/resources/rediscloud_active_active_subscription.md b/docs/resources/rediscloud_active_active_subscription.md index 8c827e33..7fdfcdcb 100644 --- a/docs/resources/rediscloud_active_active_subscription.md +++ b/docs/resources/rediscloud_active_active_subscription.md @@ -59,14 +59,14 @@ The following arguments are supported: * `payment_method` (Optional) The payment method for the requested subscription, (either `credit-card` or `marketplace`). If `credit-card` is specified, `payment_method_id` must be defined. Default: 'credit-card'. **(Changes to) this attribute are ignored after creation.** * `payment_method_id` - (Optional) A valid payment method pre-defined in the current account. This value is __Optional__ for AWS/GCP Marketplace accounts, but __Required__ for all other account types * `cloud_provider` - (Optional) The cloud provider to use with the subscription, (either `AWS` or `GCP`). Default: ‘AWS’. **Modifying this attribute will force creation of a new resource.** -* `redis_version` - (Optional) If specified, the Redis Version defines the cluster version. **Modifying this attribute will force creation of a new resource.** +* `redis_version` - (Optional) The Redis version of the databases in the subscription. If omitted, the Redis version will be the default. **Modifying this attribute will force creation of a new resource.** * `creation_plan` - (Required) A creation plan object, documented below. Ignored after creation. The `creation_plan` block supports: * `memory_limit_in_gb` - (Required) Maximum memory usage that will be used for your largest planned database, including replication and other overhead * `quantity` - (Required) The planned number of databases in the subscription. -* `modules` - (Optional) A list of modules to be enabled on all deployments of this database. Either: `RedisJSON` or 'RediSearch'. +* `modules` - (Optional) A list of modules to be enabled on all deployments of this database. Either: `RedisJSON` or `RediSearch`. * `region` - (Required) Deployment region block, documented below The creation_plan `region` block supports: diff --git a/docs/resources/rediscloud_active_active_subscription_database.md b/docs/resources/rediscloud_active_active_subscription_database.md index 6f23763a..76eb5686 100644 --- a/docs/resources/rediscloud_active_active_subscription_database.md +++ b/docs/resources/rediscloud_active_active_subscription_database.md @@ -95,7 +95,7 @@ The following arguments are supported: * `global_data_persistence` - (Optional) Global rate of database data persistence (in persistent storage) of regions that dont override global settings. Default: 'none' * `global_password` - (Optional) Password to access the database of regions that don't override global settings. If left empty, the password will be generated automatically * `global_alert` - (Optional) A block defining Redis database alert of regions that don't override global settings, documented below, can be specified multiple times. (either: 'dataset-size', 'datasets-size', 'throughput-higher-than', 'throughput-lower-than', 'latency', 'syncsource-error', 'syncsource-lag' or 'connections-limit') -* `global_modules` - (Optional) A list of modules to be enabled on all deployments of this database. Either: `RedisJSON` or 'RediSearch'. Ignored after database creation. +* `global_modules` - (Optional) A list of modules to be enabled on all deployments of this database. Either: `RedisJSON` or `RediSearch`. Ignored after database creation. * `global_source_ips` - (Optional) List of source IP addresses or subnet masks of regions that don't override global settings. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24']) * `global_resp_version` - (Optional) Either 'resp2' or 'resp3'. Resp version for Crdb databases within the AA database. Must be compatible with Redis version. * `port` - (Optional) TCP port on which the database is available - must be between 10000 and 19999. **Modifying this attribute will force creation of a new resource.** diff --git a/docs/resources/rediscloud_essentials_database.md b/docs/resources/rediscloud_essentials_database.md index e841223e..f91bd476 100644 --- a/docs/resources/rediscloud_essentials_database.md +++ b/docs/resources/rediscloud_essentials_database.md @@ -7,7 +7,7 @@ description: |- # Resource: rediscloud_essentials_database -This resource allows you to manage a database within your Redis Enterprise Cloud account. +This resource allows you to manage an Essentials database within your Redis Enterprise Cloud account. -> **Note:** This is for databases within Essential Subscriptions only. See also `rediscloud_subscription_database` (Pro) and `rediscloud_active_active_subscription_database`. diff --git a/docs/resources/rediscloud_essentials_subscription.md b/docs/resources/rediscloud_essentials_subscription.md index bfc969c8..fee64fb5 100644 --- a/docs/resources/rediscloud_essentials_subscription.md +++ b/docs/resources/rediscloud_essentials_subscription.md @@ -7,7 +7,7 @@ description: |- # Resource: rediscloud_essentials_subscription -This resource allows you to manage a subscription within your Redis Enterprise Cloud account. +This resource allows you to manage an Essentials subscription within your Redis Enterprise Cloud account. -> **Note:** This is for Essential Subscriptions only. See also `rediscloud_subscription` (Pro) and `rediscloud_active_active_subscription`. diff --git a/docs/resources/rediscloud_subscription.md b/docs/resources/rediscloud_subscription.md index a958c96f..f7dacefb 100644 --- a/docs/resources/rediscloud_subscription.md +++ b/docs/resources/rediscloud_subscription.md @@ -66,7 +66,7 @@ The following arguments are supported: * `payment_method` (Optional) The payment method for the requested subscription, (either `credit-card` or `marketplace`). If `credit-card` is specified, `payment_method_id` must be defined. Default: 'credit-card'. **(Changes to) this attribute are ignored after creation.** * `payment_method_id` - (Optional) A valid payment method pre-defined in the current account. This value is __Optional__ for AWS/GCP Marketplace accounts, but __Required__ for all other account types * `memory_storage` - (Optional) Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. **Modifying this attribute will force creation of a new resource.** -* `redis_version` - (Optional) If specified, the Redis Version defines the cluster version. **Modifying this attribute will force creation of a new resource.** +* `redis_version` - (Optional) The Redis version of the databases in the subscription. If omitted, the Redis version will be the default. **Modifying this attribute will force creation of a new resource.** * `allowlist` - (Optional) An allowlist object, documented below * `cloud_provider` - (Required) A cloud provider object, documented below. **Modifying this attribute will force creation of a new resource.** * `creation_plan` - (Required) A creation plan object, documented below @@ -94,7 +94,7 @@ The `creation_plan` block supports: * `support_oss_cluster_api` - (Optional) Support Redis open-source (OSS) Cluster API. Default: ‘false’ * `replication` - (Optional) Databases replication. Default: ‘true’ * `quantity` - (Required) The planned number of databases in the subscription -* `throughput_measurement_by` - (Required) Throughput measurement method that will be used by your databases. Either ‘number-of-shards’ or ‘operations-per-second'. **'number-of-shards' is deprecated and only supported for legacy deployments.** +* `throughput_measurement_by` - (Required) Throughput measurement method that will be used by your databases. Either `number-of-shards` or `operations-per-second`. **`number-of-shards` is deprecated and only supported for legacy deployments.** * `throughput_measurement_value` - (Required) Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases * `average_item_size_in_bytes` - (Optional) Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to diff --git a/docs/resources/rediscloud_subscription_database.md b/docs/resources/rediscloud_subscription_database.md index 857b1e0c..36baf72f 100644 --- a/docs/resources/rediscloud_subscription_database.md +++ b/docs/resources/rediscloud_subscription_database.md @@ -76,7 +76,7 @@ The following arguments are supported: * `subscription_id` - (Required) The ID of the subscription to create the database in. **Modifying this attribute will force creation of a new resource.** * `name` - (Required) A meaningful name to identify the database -* `throughput_measurement_by` - (Required) Throughput measurement method that will be used by your databases. Either ‘number-of-shards’ or ‘operations-per-second'. **'number-of-shards' is deprecated and only supported for legacy deployments.** +* `throughput_measurement_by` - (Required) Throughput measurement method that will be used by your databases. Either `number-of-shards` or `operations-per-second`. **`number-of-shards` is deprecated and only supported for legacy deployments.** * `throughput_measurement_value` - (Required) Throughput value (as applies to selected measurement method) * `memory_limit_in_gb` - (Required) Maximum memory usage for this specific database * `protocol` - (Optional) The protocol that will be used to access the database, (either ‘redis’ or ‘memcached’) Default: ‘redis’. **Modifying this attribute will force creation of a new resource.**