https://github.com/massdriver-cloud/aws-opensearch
https://github.com/massdriver-cloud/aws-opensearch
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/aws-opensearch
- Owner: massdriver-cloud
- License: mit
- Created: 2023-01-18T04:57:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T19:13:19.000Z (9 months ago)
- Last Synced: 2025-01-23T03:13:39.038Z (5 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 45.9 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# aws-opensearch
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
Amazon OpenSearch is a managed service that allows you to set up, manage, and scale a search engine for your website or application. It is built on top of Apache Lucene and provides a simple and easy-to-use interface for adding search functionality to your application.
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`cluster`** *(object)*: Cluster Configuration.
- **`data_nodes`** *(object)*
- **`instance_count`** *(integer)*: Number of instances in the cluster. Minimum: `1`. Maximum: `80`. Default: `1`.
- **`instance_storage_type`** *(string)*: Storage type for workloads. This will effect the available instances types. Default: `EBS`.
- **One of**
- EBS - Elastic Block Store
- SSD/NVMe - Non-Volatile Memory Express
- **`master_nodes`** *(object)*: Amazon OpenSearch Service uses dedicated master nodes to increase cluster stability. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
- **`enabled`** *(boolean)*: Enables 3 dedicated master nodes. Types are automatically selected based on your data node types. Default: `False`.
- **`logging`** *(object)*
- **`audit_logs`** *(integer)*: Must be one of: `[1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, 3653]`. Default: `365`.
- **`es_application_logs`** *(integer)*: Must be one of: `[1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, 3653]`. Default: `30`.
- **`index_slow_logs`** *(integer)*: Must be one of: `[1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, 3653]`. Default: `30`.
- **`search_slow_logs`** *(integer)*: Must be one of: `[1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, 3653]`. Default: `30`.
- **`networking`** *(object)*
- **`subnet_type`** *(string)*: Deploy the database to internal subnets (cannot reach the internet) or private subnets (internet egress traffic allowed). Must be one of: `['internal', 'private']`. Default: `internal`.
- **`opensearch`** *(object)*: OpenSearch Configuration.
- **`version`** *(string)*: Default: `OpenSearch_2.3`.
- **One of**
- 2.3
- 1.3
- 1.2
- 1.1
- 1.0
## Examples
```json
{
"__name": "Development",
"cluster": {
"data_nodes": {
"ebs_options": {
"volume_size_gib": 10,
"volume_type": "gp2"
},
"instance_count": 1,
"instance_storage_type": "EBS",
"instance_type": "m6g.large.search"
},
"master_nodes": {
"enabled": false
}
},
"logging": {
"audit_logs": 1,
"es_application_logs": 1,
"index_slow_logs": 1,
"search_slow_logs": 1
},
"networking": {
"subnet_type": "internal"
},
"opensearch": {
"version": "OpenSearch_2.3"
}
}
```
```json
{
"__name": "Production",
"cluster": {
"data_nodes": {
"instance_count": 3,
"instance_storage_type": "SSD",
"instance_type": "r6gd.xlarge.search"
},
"master_nodes": {
"enabled": true
}
},
"logging": {
"audit_logs": 90,
"es_application_logs": 30,
"index_slow_logs": 30,
"search_slow_logs": 30
},
"networking": {
"subnet_type": "internal"
},
"opensearch": {
"version": "OpenSearch_2.3"
}
}
```
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`aws_authentication`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`external_id`** *(string)*: An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
- **`network`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`infrastructure`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`cidr`** *(string)*
Examples:
```json
"10.100.0.0/16"
```
```json
"192.24.12.0/22"
```
- **`internal_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`private_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`public_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
- **`authentication`** *(object)*: Authentication for OpenSearch. Cannot contain additional properties.
- **`data`** *(object)*: Cannot contain additional properties.
- **`authentication`** *(object)*: Master Username & Password Authentication.
- **`hostname`** *(string)*
- **`password`** *(string)*
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`username`** *(string)*
- **`infrastructure`** *(object)*: Cloud specific infrastructure details.
- **One of**
- AWS Infrastructure ARN*object*: Minimal AWS Infrastructure Config. Cannot contain additional properties.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`security`** *(object)*: IAM Security Policies.
- **Any of**
- AWS Security information*object*: Informs downstream services of network and/or IAM policies. Cannot contain additional properties.
- **`iam`** *(object)*: IAM Policies. Cannot contain additional properties.
- **`^[a-z]+[a-z_]*[a-z]+$`** *(object)*
- **`policy_arn`** *(string)*: AWS IAM policy ARN.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`identity`** *(object)*: For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.
- **`role_arn`** *(string)*: ARN for this resources IAM Role.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`network`** *(object)*: AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.
- **`^[a-z-]+$`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`protocol`** *(string)*: Must be one of: `['tcp', 'udp']`.
- **`specs`** *(object)*: Cannot contain additional properties.
- **`opensearch`** *(object)*
- **`version`** *(string)*: Default: ``.
Examples:
```json
"1.3"
```
```json
"2.0"
```
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/aws-opensearch/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/aws-opensearch/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/aws-opensearch/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/aws-opensearch/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/aws-opensearch/issues
[release_url]: https://github.com/massdriver-cloud/aws-opensearch/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/aws-opensearch.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/aws-opensearch/blob/main/LICENSE
[email_url]: mailto:[email protected]
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:[email protected]
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-opensearch&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500