Skip to content

Latest commit

 

History

History
115 lines (77 loc) · 5.35 KB

README.md

File metadata and controls

115 lines (77 loc) · 5.35 KB
Raw

OpenSearch Project Helm Charts

A community repository for Helm Charts of OpenSearch Project.

Status

Lint and Test Charts Release Charts

Version and Branching

As of now, this helm-charts repository maintains 3 branches:

  • main (Version is 2.x.x for both version and appVersion in Chart.yaml)
  • 1.x (Version is 1.x.x for both version and appVersion in Chart.yaml)
  • gh-pages (Reserved branch for publishing helm-charts through github pages)

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 [backport 1.x] in the title, with label backport 1.x, etc.
  • No changes should be commited to gh-pages by any contributor, as this branch should be only changed by github actions chart-releaser

Kubernetes Version Support

  • This helm-chart repository is tested with kubernetes version 1.19 and above

Installation

To install the OpenSearch Helm charts, execute the following commands:

helm repo add opensearch https://opensearch-project.github.io/helm-charts/
helm repo update

Once the charts repository reference is added, you can run the following command to see the charts.

helm search repo opensearch

You can now deploy charts with this command.

helm install my-deployment opensearch/<chart name>

Please see the README.md in the OpenSearch and OpenSearch Dashboards directories for installation instructions.

Breaking Change

For OpenSearch Chart version 2.18.0 and App Version OpenSearch version 2.12.0 and above require a custom strong password to be provided in order to setup demo admin user during the first time cluster installation, without this password the cluster would not spin up, unless demo config install is disabled or the cluster security settings are handled by the user.

Note: This wont impact users who already installed the cluster and where the security index created, only impacts users starting the brand new cluster with OpenSearch version 2.12.0 and above.

The custom admin password can be supplied by adding the environment variable OPENSEARCH_INITIAL_ADMIN_PASSWORD in the value.yml as:

extraEnvs:
  - name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
    value: <strong-password>

or during the installation example as helm install opensearch opensearch/opensearch --set extraEnvs[0].name=OPENSEARCH_INITIAL_ADMIN_PASSWORD,extraEnvs[0].value=$OPENSEARCH_INITIAL_ADMIN_PASSWORD

Notes About Default Installation

By default, on startup, the install_demo_configuration.sh is runned via the opensearch-docker-entrypoint.sh script if DISABLE_INSTALL_DEMO_CONFIG is not true.

In case custom certificates are used and allow_unsafe_democertificates is set to false in the configuration, this can prevent pods to start with the following error: Demo certificates found but plugins.security.allow_unsafe_democertificates is set to false.

This can be solved by adding an environment variable in the value.yml:

extraEnvs:
  - name: DISABLE_INSTALL_DEMO_CONFIG
    value: "true"

Change Logs

Please review the OpenSearch and the OpenSearch Dashboards change logs for the latest release details.

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.