Change Opensearch instance type in AWS examples (#4786)

* fix: change position of tip and fix wording * fix: add changes to /docs as well * update language * fix indentation * update terraform --------- Co-authored-by: Cole Garbo <[email protected]>
camunda · Jan 7, 2025 · 02d3be6 · 02d3be6
1 parent af8d019
commit 02d3be6
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 4 deletions.
diff --git a/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md b/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md
@@ -931,7 +931,7 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
    ```shell
    aws opensearch create-domain --domain-name $OPENSEARCH_NAME \
      --engine-version OpenSearch_2.15 \
-     --cluster-config  "InstanceType=t3.medium.search,InstanceCount=3,ZoneAwarenessEnabled=true,ZoneAwarenessConfig={AvailabilityZoneCount=3}" \
+     --cluster-config  "InstanceType=m7i.large.search,InstanceCount=3,ZoneAwarenessEnabled=true,ZoneAwarenessConfig={AvailabilityZoneCount=3}" \
      --node-to-node-encryption-options Enabled=true \
      --ebs-options "EBSEnabled=true,VolumeType=gp3,VolumeSize=50,Iops=3000,Throughput=125" \
      --encryption-at-rest-options Enabled=true \
@@ -942,7 +942,7 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
    - **Domain Name**: `$OPENSEARCH_NAME` is the name of the OpenSearch domain being created.
    - **Engine Version**: Uses OpenSearch version `2.15`.
    - **Cluster Configuration**:
-     - `InstanceType=t3.medium.search` specifies the instance type for the domain.
+     - `InstanceType=m7i.large.search` specifies the instance type for the domain.
      - `InstanceCount=3` creates a cluster with 3 instances.
      - `ZoneAwarenessEnabled=true` and `ZoneAwarenessConfig={AvailabilityZoneCount=3}` enable zone awareness and spread the instances across 3 availability zones to improve fault tolerance.
    - **Node-to-Node Encryption**: Encryption for traffic between nodes in the OpenSearch cluster is enabled (`Enabled=true`).
@@ -956,6 +956,12 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
 
    This configuration creates a secure OpenSearch domain with encryption both in transit (between nodes) and at rest, zonal fault tolerance, and sufficient storage performance using `gp3` volumes. The access is restricted to resources in the VPC of the EKS cluster and is governed by the specified security group.
 
+:::tip
+
+The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs.
+
+:::
+
 6. Wait for the OpenSearch domain to be active:
 
    ```shell

diff --git a/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
@@ -418,6 +418,12 @@ Using Amazon OpenSearch Service requires [setting up a new Camunda installation]
 
 1. Customize the cluster setup using various input options. For a full list of available parameters, see the [OpenSearch module documentation](https://github.com/camunda/camunda-tf-eks-module/blob/2.6.0/modules/opensearch/README.md).
 
+:::tip
+
+The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs.
+
+:::
+
 ### Define outputs
 
 **Terraform** allows you to define outputs, which make it easier to retrieve important values generated during execution, such as database endpoints and other necessary configurations for Helm setup.

diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md
@@ -931,7 +931,7 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
    ```shell
    aws opensearch create-domain --domain-name $OPENSEARCH_NAME \
      --engine-version OpenSearch_2.15 \
-     --cluster-config  "InstanceType=t3.medium.search,InstanceCount=3,ZoneAwarenessEnabled=true,ZoneAwarenessConfig={AvailabilityZoneCount=3}" \
+     --cluster-config  "InstanceType=m7i.large.search,InstanceCount=3,ZoneAwarenessEnabled=true,ZoneAwarenessConfig={AvailabilityZoneCount=3}" \
      --node-to-node-encryption-options Enabled=true \
      --ebs-options "EBSEnabled=true,VolumeType=gp3,VolumeSize=50,Iops=3000,Throughput=125" \
      --encryption-at-rest-options Enabled=true \
@@ -942,7 +942,7 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
    - **Domain Name**: `$OPENSEARCH_NAME` is the name of the OpenSearch domain being created.
    - **Engine Version**: Uses OpenSearch version `2.15`.
    - **Cluster Configuration**:
-     - `InstanceType=t3.medium.search` specifies the instance type for the domain.
+     - `InstanceType=m7i.large.search` specifies the instance type for the domain.
      - `InstanceCount=3` creates a cluster with 3 instances.
      - `ZoneAwarenessEnabled=true` and `ZoneAwarenessConfig={AvailabilityZoneCount=3}` enable zone awareness and spread the instances across 3 availability zones to improve fault tolerance.
    - **Node-to-Node Encryption**: Encryption for traffic between nodes in the OpenSearch cluster is enabled (`Enabled=true`).
@@ -956,6 +956,12 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con
 
    This configuration creates a secure OpenSearch domain with encryption both in transit (between nodes) and at rest, zonal fault tolerance, and sufficient storage performance using `gp3` volumes. The access is restricted to resources in the VPC of the EKS cluster and is governed by the specified security group.
 
+:::tip
+
+The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs.
+
+:::
+
 6. Wait for the OpenSearch domain to be active:
 
    ```shell

diff --git a/...docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/...docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
@@ -420,6 +420,12 @@ Using Amazon OpenSearch Service requires [setting up a new Camunda installation]
 
 1. Customize the cluster setup using various input options. For a full list of available parameters, see the [OpenSearch module documentation](https://github.com/camunda/camunda-tf-eks-module/blob/2.6.0/modules/opensearch/README.md).
 
+:::tip
+
+The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs.
+
+:::
+
 ### Define outputs
 
 **Terraform** allows you to define outputs, which make it easier to retrieve important values generated during execution, such as database endpoints and other necessary configurations for Helm setup.