Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opensearch-project/helm-charts
:wheel_of_dharma: A community repository for Helm Charts of OpenSearch Project.
https://github.com/opensearch-project/helm-charts
Last synced: about 1 month ago
JSON representation
:wheel_of_dharma: A community repository for Helm Charts of OpenSearch Project.
- Host: GitHub
- URL: https://github.com/opensearch-project/helm-charts
- Owner: opensearch-project
- License: apache-2.0
- Created: 2021-08-06T20:49:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T23:38:28.000Z (about 1 month ago)
- Last Synced: 2024-08-14T21:49:23.240Z (about 1 month ago)
- Language: Smarty
- Homepage: https://opensearch.org/docs/latest/opensearch/install/helm/
- Size: 519 KB
- Stars: 161
- Watchers: 18
- Forks: 223
- Open Issues: 120
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
- [OpenSearch Project Helm-Charts](#opensearch-project-helm-charts)
- [Status](#status)
- [Version and Branching](#version-and-branching)
- [Installation](#installation)
- [Change Logs](#change-logs)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
## OpenSearch Project Helm Charts
A community repository for Helm Charts of OpenSearch Project.
## Status
[](https://github.com/opensearch-project/helm-charts/actions/workflows/lint-test.yaml)
[](https://github.com/opensearch-project/helm-charts/actions/workflows/release.yaml)
## 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:
```shell
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.
```shell
helm search repo opensearch
```
You can now deploy charts with this command.
```shell
helm install my-deployment opensearch/
```
Please see the `README.md` in the [OpenSearch](charts/opensearch) and [OpenSearch Dashboards](charts/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:
```
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](charts/opensearch/CHANGELOG.md) and the
[OpenSearch Dashboards](charts/opensearch-dashboards/CHANGELOG.md) change logs for the latest
release details.
## 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). 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.txt).