Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/opensearch-project/terraform-provider-opensearch


https://github.com/opensearch-project/terraform-provider-opensearch

opensearch terraform

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README 

        



- [Terraform Provider OpenSearch](#Terraform-Provider-OpenSearch)

- [Compatibility](#compatibility)

- [Version and Branching](#version-and-branching)

- [Contributing](#contributing)

- [Maintainer Responsibilities](MAINTAINERS.md)

- [Getting Help](#getting-help)

- [Code of Conduct](#code-of-conduct)

- [Security](#security)

- [License](#license)

- [Copyright](#copyright)



## Terraform Provider OpenSearch



This is a terraform provider to provision OpenSearch resources.



### Supported Functionalities 



Examples of resources can be found in the examples directory.



#### OpenSearch and OpenSearch Dashboards



- [x] [Cluster Settings](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/)

- [x] [Audit Config](https://opensearch.org/docs/latest/security/audit-logs/index/)

- [x] [Component templates](https://opensearch.org/docs/latest/dashboards/im-dashboards/component-templates/)

- [x] [Index and Composable templates](https://opensearch.org/docs/latest/im-plugin/index-templates/)

- [x] [Data Streams](https://opensearch.org/docs/2.9/dashboards/im-dashboards/datastream/)

- [x] [Ingest Pipeline](https://opensearch.org/docs/2.9/api-reference/ingest-apis/create-update-ingest/)

- [x] [Security](https://opensearch.org/docs/latest/security/index/)

- [x] [Snapshot Repository](https://opensearch.org/docs/2.9/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#register-repository)

- [x] [Anomaly Detection](https://opensearch.org/docs/latest/observing-your-data/ad/index/)

- [x] [Index State Management](https://opensearch.org/docs/latest/im-plugin/ism/index/)

- [x] [Dashboards Visualization](https://opensearch.org/docs/latest/dashboards/visualize/viz-index/)

- [x] [Dashboards Tenant](https://opensearch.org/docs/latest/security/multi-tenancy/tenant-index/)

- [x] [Alerting Monitors](https://opensearch.org/docs/latest/observing-your-data/alerting/monitors/)

- [x] [Notification Channels](https://opensearch.org/docs/latest/observing-your-data/notifications/index/)



### Running tests locally



```sh

./script/install-tools

export OSS_IMAGE="opensearchproject/opensearch:2"

docker-compose up -d

docker-compose ps -a  # Checks that the process is running

export OPENSEARCH_URL=http://admin:admin@localhost:9200

export TF_LOG=INFO

TF_ACC=1 go test ./... -v -parallel 20 -cover -short

```



Note:  Starting from version `2.12.0`, the `admin` user password is determined by the `OPENSEARCH_INITIAL_ADMIN_PASSWORD` environment variable. If testing against a cluster with version `2.12.0` or later and have set `OPENSEARCH_INITIAL_ADMIN_PASSWORD=myStrongPassword123@456`, please update the URL as follows: `export OPENSEARCH_URL=http://admin:myStrongPassword123%40456@localhost:9200`



#### To Run Specific Test



```sh

cd provider/

TF_ACC=2 go test -run TestAccOpensearchOpenDistroDashboardTenant  -v -cover -short

```



#### Fix the go-lint errors



```sh

golangci-lint run --out-format=github-actions 

```



### Debugging this provider



Build the executable, and start in debug mode:



```console

$ go build

$ ./terraform-provider-opensearch -debuggable # or start in debug mode in your IDE

{"@level":"debug","@message":"plugin address","@timestamp":"2022-05-17T10:10:04.331668+01:00","address":"/var/folders/32/3mbbgs9x0r5bf991ltrl3p280010fs/T/plugin1346340234","network":"unix"}

Provider started, to attach Terraform set the TF_REATTACH_PROVIDERS env var:



        TF_REATTACH_PROVIDERS='{"registry.terraform.io/opensearch-project/opensearch":{"Protocol":"grpc","ProtocolVersion":5,"Pid":79075,"Test":true,"Addr":{"Network":"unix","String":"/var/folders/32/3mbbgs9x0r5bf991ltrl3p280010fs/T/plugin1346340234"}}}'

```



In another terminal, you can test your terraform code:



```console

$ cd 

$ export TF_REATTACH_PROVIDERS=

$ terraform apply

```



The local provider will be used instead, and you should see debug information printed to the terminal.



## Version and Branching



As of now, this terraform-provider-opensearch repository maintains 2 branches:



- _main_ (2.x.x OpenSearch development)

- _1.x_ (1.x.x OpenSearch development)



Contributors should choose the corresponding branch(es) when commiting their change(s):



- If you have a change for a specific version, only open PR to specific branch

- If you have a change for all available versions, first open a PR on `main`, then open a backport PR with `[x]` in the title, with label `backport 1.x`, etc.



## Contributing



See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). 



## Getting Help



If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.



For more information, see [project website](https://opensearch.org/) and [documentation](https://opensearch.org/docs/latest/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).



## Code of Conduct



This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.



## Security



If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.



## License



This project is licensed under the [Apache v2.0 License](LICENSE).



## Copyright



Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.