Skip to content

Commit f6f7d02

Browse files
committed
docs: Add explanatory values and update config examples
* Included multi-AZ standby and dedicated master node settings for clarity. * Provided a link to AWS documentation for additional context on off-peak windows. * Sort cluster_config values
1 parent b241b46 commit f6f7d02

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,13 @@ module "opensearch" {
4747
}
4848
4949
cluster_config = {
50-
instance_count = 3
50+
multi_az_with_standby_enabled = false
51+
5152
dedicated_master_enabled = true
53+
dedicated_master_count = 3
5254
dedicated_master_type = "c6g.large.search"
55+
56+
instance_count = 3
5357
instance_type = "r6g.large.search"
5458
5559
zone_awareness_config = {
@@ -124,6 +128,11 @@ module "opensearch" {
124128
}
125129
]
126130
131+
# Off-peak window
132+
off_peak_window_options = {
133+
enabled = false
134+
}
135+
127136
tags = {
128137
Terraform = "true"
129138
Environment = "dev"
@@ -212,7 +221,7 @@ No modules.
212221
| <a name="input_ip_address_type"></a> [ip\_address\_type](#input\_ip\_address\_type) | The IP address type for the endpoint. Valid values are ipv4 and dualstack | `string` | `null` | no |
213222
| <a name="input_log_publishing_options"></a> [log\_publishing\_options](#input\_log\_publishing\_options) | Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log\_type, within the same resource | `any` | <pre>[<br/> {<br/> "log_type": "INDEX_SLOW_LOGS"<br/> },<br/> {<br/> "log_type": "SEARCH_SLOW_LOGS"<br/> }<br/>]</pre> | no |
214223
| <a name="input_node_to_node_encryption"></a> [node\_to\_node\_encryption](#input\_node\_to\_node\_encryption) | Configuration block for node-to-node encryption options | `any` | <pre>{<br/> "enabled": true<br/>}</pre> | no |
215-
| <a name="input_off_peak_window_options"></a> [off\_peak\_window\_options](#input\_off\_peak\_window\_options) | Configuration to add Off Peak update options | `any` | <pre>{<br/> "enabled": true,<br/> "off_peak_window": {<br/> "hours": 7<br/> }<br/>}</pre> | no |
224+
| <a name="input_off_peak_window_options"></a> [off\_peak\_window\_options](#input\_off\_peak\_window\_options) | Configuration to add Off Peak update options. OpenSearch Service uses off-peak window to schedule service software updates and Auto-Tune optimizations that require a blue/green deployment during comparatively lower traffic times, whenever possible. Refer to the [AWS documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) for details. | `any` | <pre>{<br/> "enabled": true,<br/> "off_peak_window": {<br/> "hours": 7<br/> }<br/>}</pre> | no |
216225
| <a name="input_outbound_connections"></a> [outbound\_connections](#input\_outbound\_connections) | Map of AWS OpenSearch outbound connections to create | `any` | `{}` | no |
217226
| <a name="input_package_associations"></a> [package\_associations](#input\_package\_associations) | Map of package association IDs to associate with the domain | `map(string)` | `{}` | no |
218227
| <a name="input_saml_options"></a> [saml\_options](#input\_saml\_options) | SAML authentication options for an AWS OpenSearch Domain | `any` | `{}` | no |

0 commit comments

Comments
 (0)