Skip to content

Remove stale README for OpenSearch Helm Chart #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 1, 2021
Merged

Remove stale README for OpenSearch Helm Chart #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b36557
Remove stale README
TheAlgo Sep 22, 2021
5a57939
Merge branch 'main' of https://github.com/TheAlgo/helm-charts into re…
TheAlgo Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions charts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +0,0 @@

This Helm chart is a lightweight way to configure and run the official [OpenSearch Docker image](https://hub.docker.com/r/opensearchproject/opensearch).

- [Installing](#installing)
- [Usage notes](#usage-notes)
- [Configuration](#configuration)
- [Future](#Future)

## Installing

[OpenSearch Helm chart](https://opensearch.org/docs/opensearch/install/helm/)

[OpenSearch Dashboards Helm chart](https://opensearch.org/docs/dashboards/install/helm/)

## Usage Notes

* The chart deploys a StatefulSet and by default will do an automated rolling
update of your cluster. It does this by waiting for the cluster health to become
green after each instance is updated.
* It is important to verify that the JVM heap size in `opensearchJavaOpts` and
to set the CPU/Memory `resources` to something suitable for your cluster.
* To simplify chart and maintenance each set of node groups is deployed as a
separate Helm release. Without doing this it isn't possible to resize persistent
volumes in a StatefulSet. By setting it up this way it makes it possible to add
more nodes with a new storage size then drain the old ones. It also solves the
problem of allowing the user to determine which node groups to update first when
doing upgrades or changes.
* We have designed this chart to be very un-opinionated about how to configure
OpenSearch. It exposes ways to set environment variables and mount secrets
inside of the container. Doing this makes it much easier for this chart to
support multiple versions with minimal changes.

## Configuration
TODO : Write about all the parameters used

## Future
* Create example for different types of configurations for different K8S providers.
* Have a chart for deploying the OpenSearch stack comprising OpenSearch and OpenSearch Dashboards