Skip to main content

OpenSearch (Amazon OpenSearch Service)

Prerequisites​

  1. Required Installations

  2. Service Role Setup Run the following AWS CLI command to enable OpenSearch service role:

    aws iam create-service-linked-role --aws-service-name opensearchservice.amazonaws.com

Installation Process​

1. Select AWS Region​

Choose the same region as your FormKiQ installation:

AWS RegionLocationInstall Link
us-east-1N. VirginiaInstall
us-east-2OhioInstall
us-west-2OregonInstall
ca-central-1Canada (Central)Install
eu-central-1FrankfurtInstall
eu-west-1IrelandInstall
eu-west-3ParisInstall
ap-south-1MumbaiInstall
ap-southeast-1SingaporeInstall
ap-southeast-2SydneyInstall
ap-northeast-2SeoulInstall
sa-east-1São PauloInstall

2. Create Stack​

  1. Access CloudFormation console via the installation link
  2. Enter the OpenSearch module S3 URL (provided separately)

CloudFormation Create Stack

3. Configure Stack Name​

Format: formkiq-enterprise-opensearch-<environment> Example: formkiq-enterprise-opensearch-prod

CloudFormation Stack Name

Configuration Parameters​

Basic Configuration​

ParameterDescriptionDevelopment Recommendation
AppEnvironmentEnvironment identifier (dev/staging/prod)Must match FormKiQ installation
NameDomain name (3-28 chars)Format: formkiq-enterprise-<environment>
OpenSearchVersionOpenSearch versionLatest stable version

Instance Configuration​

ParameterDescriptionDevelopment Recommendation
DataInstanceCountNumber of data nodes1
DataInstanceTypeInstance type for data nodest3.small.search
DataNodeVolumeSizeEBS volume size (GiB)10

Dedicated Master Configuration​

ParameterDescriptionDevelopment Recommendation
DedicatedMasterEnabledEnable dedicated master nodesfalse
DedicatedMasterCountNumber of master nodes0
DedicatedMasterTypeMaster node instance typet3.small.search

Storage Configuration​

ParameterDescriptionRecommendation
EBSVolumeTypeEBS volume typegp3
ZoneAwarenessConfigEnable zone awarenessDepends on replica requirements

Network Configuration​

ParameterDescriptionNotes
VpcStackNameVPC stack nameMust match existing VPC stack
VpcSubnetsDeployment subnetsSelect private subnets only
note

For development with single data node, select only one subnet

Post-Installation Steps​

1. Update FormKiQ Stack​

  1. Select your FormKiQ stack in CloudFormation
  2. Click "Update"
  3. Choose "Use current template"
  4. Set OpenSearchStackName to your OpenSearch stack name

OpenSearch Stack Name

2. Complete Update​

  1. Review configuration
  2. Navigate through confirmation screens
  3. Acknowledge capabilities
  4. Submit stack update

Submit Create Stack

Post-Deployment Notes​

  • Documents and metadata automatically sync with OpenSearch
  • Document content sync requires explicit configuration
  • Verify cluster health after deployment
  • Monitor resource usage

Development Configuration Summary​

For development environments, recommended settings:

  • Single data node (DataInstanceCount: 1)
  • t3.small.search instances
  • No dedicated master nodes
  • 10GB storage
  • gp3 volume type
  • Single private subnet deployment