Correct defaults for opensearchJavaOpts in README (#570) (#571)

* Update README.md opensearchJavaOpts defaults * version to 2.22.1 * 2.22.1 in CHANGELOG.md --------- Signed-off-by: Joel Eidsath <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Joel Eidsath <[email protected]>
opensearch-project · Aug 13, 2024 · 55841ee · 55841ee
1 parent 1b6c35a
commit 55841ee
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -12,6 +12,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [1.28.1]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+- Fixed opensearchJavaOpts defaults in README
+### Security
+---
 ## [1.28.0]
 ### Added
 ### Changed
@@ -699,7 +708,8 @@ config:
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.28.0...HEAD
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.28.1...HEAD
+[1.28.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.28.0...opensearch-1.28.1
 [1.28.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.27.0...opensearch-1.28.0
 [1.27.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.26.0...opensearch-1.27.0
 [1.26.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.25.0...opensearch-1.26.0

diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.28.0
+version: 1.28.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/opensearch/README.md b/charts/opensearch/README.md
@@ -43,7 +43,7 @@ helm uninstall my-release
 | `enableServiceLinks`               | Set to false to disabling service links, which can cause slow pod startup times when there are many services in the current namespace.                                                                                                                    | `true`                                          |
 | `envFrom`                          | Templatable string to be passed to the [environment from variables][] which will be appended to the `envFrom:` definition for the container                                                                                                               | `[]`                                            |
 | `config`                         | Allows you to add any config files in `/usr/share/opensearch/config/` such as `opensearch.yml` and `log4j2.properties`. String or map format may be used for specifying content of each configuration file. In case of string format, the whole content of the config file will be replaced by new config file value when in case of using map format content of configuration file will be a result of merge. In both cases content passed through tpl. See [values.yaml][] for an example of the formatting (passed through tpl)                                                         | `{}`                                            |
-| `opensearchJavaOpts`                        | Java options for OpenSearch. This is where you should configure the jvm heap size                                                                                                                                                             | `-Xmx1g -Xms1g`                                 |
+| `opensearchJavaOpts`                        | Java options for OpenSearch. This is where you should configure the jvm heap size                                                                                                                                                             | `-Xmx512M -Xms512M`                                 |
 | `majorVersion`                   | Used to set major version specific configuration. If you are using a custom image and not running the default OpenSearch version you will need to set this to the version you are running (e.g. `majorVersion: 1`)                                   | `""`                                            |
 | `global.dockerRegistry`                  | Set if you want to change the default docker registry, e.g. a private one.                                                                                                                                           | `""`                                            |
 | `extraContainers`                  | Array of extra containers                                                                                                                                           | `""`                                            |