Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Opensearch instance type in AWS examples #4786

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+28 −4
Open

Change Opensearch instance type in AWS examples #4786

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f0f1d00
fix: change position of tip and fix wording
bkenez Dec 17, 2024
b2c7286
fix: add changes to /docs as well
bkenez Dec 17, 2024
0efeef1
Merge branch 'main' into infex-461-update-docs-on-instance-type
conceptualshark Dec 18, 2024
3024edb
update language
conceptualshark Dec 18, 2024
8e17868
fix indentation
conceptualshark Dec 18, 2024
5504541
update terraform
conceptualshark Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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`).
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 8 additions & 2 deletions versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eksctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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`).
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions ...docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading