• Terraform Provider OpenSearch
• Compatibility
• Version and Branching
• Contributing
• Maintainer Responsibilities
• Getting Help
• Code of Conduct
• Security
• License
• 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

• Cluster Settings
• Audit Config
• Component templates
• Index and Composable templates
• Data Streams
• Ingest Pipeline
• Security
• Snapshot Repository
• Anomaly Detection
• Index State Management
• Dashboards Visualization
• Dashboards Tenant
• Alerting Monitors
• Notification Channels

Running tests locally

./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

cd provider/
TF_ACC=2 go test -run TestAccOpensearchOpenDistroDashboardTenant  -v -cover -short

Fix the go-lint errors

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

Debugging this provider

Build the executable, and start in debug mode:

$ 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:

$ cd <my-project/terraform>
$ export TF_REATTACH_PROVIDERS=<env var above>
$ 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 and how to contribute to this project.

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 and documentation. If you need help and are unsure where to open an issue, try forums.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [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. Please do not create a public GitHub issue.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.