AWS opensearch-service documentation change
Summary
Updated documentation for OpenSearch optimized instances, including terminology changes, section renames, and added encryption-at-rest guidance in provisioning steps
Security assessment
Added explicit instruction to enable encryption at rest during domain creation (step 6 in console instructions and CLI example). While encryption at rest is a security feature, there's no evidence this change addresses a specific security vulnerability.
Diff
diff --git a/opensearch-service/latest/developerguide/or1.md b/opensearch-service/latest/developerguide/or1.md index dec69cc86..ad5788839 100644 --- a//opensearch-service/latest/developerguide/or1.md +++ b//opensearch-service/latest/developerguide/or1.md @@ -5 +5 @@ -LimitationsTuning for better ingestion throughputHow OpenSearch optimized instances differ from non OpenSearch optimized instances How OR1 differs from UltraWarm storageUsing OR1 instances +LimitationsTuning for better ingestion throughputHow OpenSearch optimized instances differ from other instancesHow OR1 differs from UltraWarm storageProvisioning a domain with OR1 instances @@ -7 +7 @@ LimitationsTuning for better ingestion throughputHow OpenSearch optimized instan -# OR1 storage for Amazon OpenSearch Service +# OpenSearch optimized storage for Amazon OpenSearch Service @@ -9 +9 @@ LimitationsTuning for better ingestion throughputHow OpenSearch optimized instan -OR1 is an instance family for Amazon OpenSearch Service that provides a cost-effective way to store large amounts of data. A domain with OR1 instances uses Amazon Elastic Block Store (Amazon EBS) `gp3` or `io1` volumes for primary storage, with data copied synchronously to Amazon S3 as it arrives. This storage structure provides increased indexing throughput with high durability. The OR1 instance family also supports automatic data recovery in the event of failure. For information about OR1 instance type options, see [Current generation instance types](./supported-instance-types.html#latest-gen). +The OpenSearch optimized instance family for Amazon OpenSearch Service is a cost-effective solution for storing large volumes of data. A domain with OR1 instances uses Amazon Elastic Block Store (Amazon EBS) `gp3` or `io1` volumes for primary storage, with data copied synchronously to Amazon S3 as it arrives. This storage structure provides increased indexing throughput with high durability. The OpenSearch optimized instance family also supports automatic data recovery in the event of failure. For information about OR1 instance type options, see [Current generation instance types](./supported-instance-types.html#latest-gen). @@ -23 +23 @@ OR1 instances are available on-demand or with Reserved Instance pricing, with an - * How OpenSearch optimized instances differ from non OpenSearch optimized instances + * How OpenSearch optimized instances differ from other instances @@ -27 +27 @@ OR1 instances are available on-demand or with Reserved Instance pricing, with an - * Using OR1 instances + * Provisioning a domain with OR1 instances @@ -42 +42 @@ Consider the following limitations when using OR1 instances for your domain. - * If your domain uses dedicated master nodes, they must use Graviton instances. For more information about dedicated master nodes, see [Dedicated manager nodes in Amazon OpenSearch Service](./managedomains-dedicatedmasternodes.html). + * If your domain uses dedicated master nodes, they must use Graviton instances. For more information about dedicated master nodes, see [Dedicated master nodes in Amazon OpenSearch Service](./managedomains-dedicatedmasternodes.html). @@ -51 +51 @@ Consider the following limitations when using OR1 instances for your domain. -To get the best indexing throughput from your OR1 instances, it is recommended you do the following: +To get the best indexing throughput from your OR1 instances, we recommend that you do the following: @@ -53 +53 @@ To get the best indexing throughput from your OR1 instances, it is recommended y - * Use Large Bulk Sizes to improve buffer utilization. The recommended size is 10 MB. + * Use large bulk sizes to improve buffer utilization. The recommended size is 10 MB. @@ -62 +62 @@ To get the best indexing throughput from your OR1 instances, it is recommended y -## How OpenSearch optimized instances differ from non OpenSearch optimized instances +## How OpenSearch optimized instances differ from other instances @@ -64 +64 @@ To get the best indexing throughput from your OR1 instances, it is recommended y -OpenSearch optimized instances differ from non OpenSearch optimized instances in the following ways: +OpenSearch optimized instances differ from non-optimized instances in the following ways: @@ -68 +68 @@ OpenSearch optimized instances differ from non OpenSearch optimized instances in - * If OpenSearch optimized instances are configured with replicas, the indexing rate may appear lower than it actually is. For example, if there is 1 primary shard and 1 replica shard, the indexing rate may show a rate of 1000, however, the actual indexing rate is 2000. + * If OpenSearch optimized instances are configured with replicas, the indexing rate may appear lower than it actually is. For example, if there is one primary shard and one replica shard, the indexing rate might show a rate of 1000 when the actual indexing rate is 2000. @@ -74 +74 @@ OpenSearch optimized instances differ from non OpenSearch optimized instances in -The `IndexingLatency` metric is not affected, as it doesn’t include time to sync translog. ) +The `IndexingLatency` metric is not affected, as it doesn’t include time to sync translog. @@ -76 +76 @@ The `IndexingLatency` metric is not affected, as it doesn’t include time to sy - * Replica shards can be a few seconds behind primary shards. The time lag can be seen from `ReplicationLagMaxTime` metric + * Replica shards can be a few seconds behind primary shards. You can monitor the lag using the `ReplicationLagMaxTime` Amazon CloudWatch metric @@ -96 +96 @@ For more information about UltraWarm storage, see [UltraWarm storage for Amazon -## Using OR1 instances +## Provisioning a domain with OR1 instances @@ -98 +98 @@ For more information about UltraWarm storage, see [UltraWarm storage for Amazon -You can select OR1 instances for your data nodes when you create a new domain with the AWS Management Console, the AWS Command Line Interface (AWS CLI), or the AWS SDK. You can then index and query the data using your existing tools. +You can select OR1 instances for your data nodes when you create a new domain with the AWS Management Console or the AWS Command Line Interface (AWS CLI). You can then index and query the data using your existing tools. @@ -106 +106 @@ You can select OR1 instances for your data nodes when you create a new domain wi - 4. Enter a name for your domain along with your other preferred options. Under **Instance family** , choose **OR1**. Choose **Create** to start the domain creation process. + 4. In the **Number of data nodes** section, expand the **Instance family** menu and choose **OpenSearch optimized**. @@ -107,0 +108 @@ You can select OR1 instances for your data nodes when you create a new domain wi + 5. Choose the instance type and other storage settings. @@ -108,0 +110 @@ You can select OR1 instances for your data nodes when you create a new domain wi + 6. In the **Encryption** section, make sure that **Enable encryption of data at rest** is selected. @@ -109,0 +112 @@ You can select OR1 instances for your data nodes when you create a new domain wi + 7. Configure the rest of your domain and choose **Create**. @@ -111 +113,0 @@ You can select OR1 instances for your data nodes when you create a new domain wi - 1. Navigate to your AWS CLI terminal. If you need to install the AWS CLI, see [Install or update the latest version of the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). @@ -113 +114,0 @@ You can select OR1 instances for your data nodes when you create a new domain wi - 2. To use OR1 storage, you must provide the value of the specific OR1 instance type size in the `InstanceType` field when you create a domain. You must also enable encryption at rest. @@ -115 +116,5 @@ You can select OR1 instances for your data nodes when you create a new domain wi -The following example creates a domain with OR1 instances of size `2xlarge`. + +To provision a domain that uses OR1 storage using the AWS CLI, you must provide the value of the specific OR1 instance type size in the `InstanceType`. + +The following example creates a domain with OR1 instances of size `2xlarge` and enables encryption at rest. +