From f0f1d00d892e08d0caa01ee9e749b99629bc61e5 Mon Sep 17 00:00:00 2001 From: Balazs Kenez <96087935+bkenez@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:31:55 +0100 Subject: [PATCH 1/5] fix: change position of tip and fix wording --- .../setup/deploy/amazon/amazon-eks/eksctl.md | 10 ++++++++-- .../setup/deploy/amazon/amazon-eks/terraform-setup.md | 6 ++++++ 2 files changed, 14 insertions(+), 2 deletions(-) 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 index 23e6f3381ff..7c18ce1cd94 100644 --- 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 just a suggestion and can be changed at your discretion depending on your needs. + +::: + 6. Wait for the OpenSearch domain to be active: ```shell diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md index 40fe91e4dc8..8c4c0e3f5c4 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md +++ b/versioned_docs/version-8.6/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 just a suggestion and can be changed at your discretion 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. From b2c7286dc55a32718a4ce3a3c6be39620ac29100 Mon Sep 17 00:00:00 2001 From: Balazs Kenez <96087935+bkenez@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:46:40 +0100 Subject: [PATCH 2/5] fix: add changes to /docs as well --- .../setup/deploy/amazon/amazon-eks/eksctl.md | 10 ++++++++-- .../setup/deploy/amazon/amazon-eks/terraform-setup.md | 6 ++++++ 2 files changed, 14 insertions(+), 2 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 index 612ce508f68..5d7d3033ac1 100644 --- 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 just a suggestion and can be changed at your discretion 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 index 7a440c0e3b0..2f867bb19cf 100644 --- 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 just a suggestion and can be changed at your discretion 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. From 3024edb178816440453d3f50c316a2e5bce684b6 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Wed, 18 Dec 2024 10:03:35 -0500 Subject: [PATCH 3/5] update language --- docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md | 6 +++--- .../self-managed/setup/deploy/amazon/amazon-eks/eksctl.md | 2 +- 2 files changed, 4 insertions(+), 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 index 5d7d3033ac1..866861cd536 100644 --- a/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md +++ b/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md @@ -958,17 +958,17 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con :::tip -The instance type `m7i.large.search` in the above example is just a suggestion and can be changed at your discretion depending on your needs. +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: +1. Wait for the OpenSearch domain to be active: ```shell while [ "$(aws opensearch describe-domain --domain-name $OPENSEARCH_NAME --query 'DomainStatus.Processing' --output text)" != "False" ]; do echo "Waiting for OpenSearch domain to become availablen this can up to take 20-30 minutes..."; sleep 30; done && echo "OpenSearch domain is now available\!" ``` -7. Retrieve the endpoint of the OpenSearch domain: +2. Retrieve the endpoint of the OpenSearch domain: ```shell export OPENSEARCH_HOST=$(aws opensearch describe-domains --domain-names $OPENSEARCH_NAME --query "DomainStatusList[0].Endpoints.vpc" --output text) 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 index 7c18ce1cd94..e7d382f70be 100644 --- 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 @@ -958,7 +958,7 @@ For more information, see the [Amazon OpenSearch Service fine-grained access con :::tip -The instance type `m7i.large.search` in the above example is just a suggestion and can be changed at your discretion depending on your needs. +The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs. ::: From 8e178682bc5ca7ccae07062e2f925fc7704b6c34 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Wed, 18 Dec 2024 10:05:59 -0500 Subject: [PATCH 4/5] fix indentation --- docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md | 4 ++-- 1 file changed, 2 insertions(+), 2 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 index 866861cd536..4d80bb0c78d 100644 --- a/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md +++ b/docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md @@ -962,13 +962,13 @@ The instance type `m7i.large.search` in the above example is a suggestion, and c ::: -1. Wait for the OpenSearch domain to be active: +6. Wait for the OpenSearch domain to be active: ```shell while [ "$(aws opensearch describe-domain --domain-name $OPENSEARCH_NAME --query 'DomainStatus.Processing' --output text)" != "False" ]; do echo "Waiting for OpenSearch domain to become availablen this can up to take 20-30 minutes..."; sleep 30; done && echo "OpenSearch domain is now available\!" ``` -2. Retrieve the endpoint of the OpenSearch domain: +7. Retrieve the endpoint of the OpenSearch domain: ```shell export OPENSEARCH_HOST=$(aws opensearch describe-domains --domain-names $OPENSEARCH_NAME --query "DomainStatusList[0].Endpoints.vpc" --output text) From 55045414f739f2ecf1a8bdf44b4fd57866df66f4 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Wed, 18 Dec 2024 10:07:06 -0500 Subject: [PATCH 5/5] update terraform --- .../setup/deploy/amazon/amazon-eks/terraform-setup.md | 2 +- .../setup/deploy/amazon/amazon-eks/terraform-setup.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 index 2f867bb19cf..24cabc8f78d 100644 --- a/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md +++ b/docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md @@ -420,7 +420,7 @@ Using Amazon OpenSearch Service requires [setting up a new Camunda installation] :::tip -The instance type `m7i.large.search` in the above example is just a suggestion and can be changed at your discretion depending on your needs. +The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs. ::: diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md index 8c4c0e3f5c4..5cf880789b2 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md @@ -420,7 +420,7 @@ Using Amazon OpenSearch Service requires [setting up a new Camunda installation] :::tip -The instance type `m7i.large.search` in the above example is just a suggestion and can be changed at your discretion depending on your needs. +The instance type `m7i.large.search` in the above example is a suggestion, and can be changed depending on your needs. :::