Enable Helm chart release (#61)

* - Added change logs for the opensearch and opensearch-dashboards Helm charts. - Amended README files to reflect the intended installation and usage. - Incremented the version numbers to 1.0.2 for both Helm charts in adherence to linting rules and Semver 2. Signed-off-by: Michael Primeaux <[email protected]> * - Modified OpenSearch chart description Signed-off-by: Michael Primeaux <[email protected]> * - Reverted to previous chart installation instructions until we can verify the new method succeeds. Signed-off-by: Michael Primeaux <[email protected]>
opensearch-project · Sep 28, 2021 · 573269d · 573269d
1 parent dd0c692
commit 573269d
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,55 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+---
+## [Unreleased-Dashboards]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+---
+## [opensearch-1.0.2]
+
+### Added
+- Added this changelog in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
+
+### Changed
+- Incremented the version to 1.0.2
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+---
+## [opensearch-dashboards-1.0.2]
+
+### Added
+- Added this changelog in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
+
+### Changed
+- Incremented the version to 1.0.2
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...HEAD
+[opensearch-1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.1...opensearch-1.0.2
+
+[Unreleased-Dashboards]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.2...HEAD
+[opensearch-dashboards1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.1...opensearch-dashboards-1.0.2
diff --git a/README.md b/README.md
@@ -1,29 +1,38 @@
 <img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
 
 - [OpenSearch Project Helm-Charts](#helm-charts)
-- [Installation](#installation)
 - [Status](#status)
+- [Installation](#installation)
+- [Change Logs](#change-logs)
 - [Contributing](#contributing)
 - [Getting Help](#getting-help)
 - [Code of Conduct](#code-of-conduct)
 - [Security](#security)
 - [License](#license)
-- [Copyright](#copyright)
 
-## OpenSearch Project Helm-Charts
+## Helm-Charts
 
 A community repository for Helm Charts of OpenSearch Project.
 
+## Status
+
+![Testing](https://github.com/opensearch-project/helm-charts/workflows/Lint%20and%20Test%20Charts/badge.svg)
+![Release](https://github.com/opensearch-project/helm-charts/workflows/Release%20Charts/badge.svg)
+
 ## Installation
 
-[OpenSearch Helm chart](https://opensearch.org/docs/opensearch/install/helm/)
+```shell
+helm repo add opensearch https://opensearch-project.github.io/helm-charts/
+helm repo update
+```
 
-[OpenSearch Dashboards Helm chart](https://opensearch.org/docs/dashboards/install/helm/)
+You can then run `helm search repo opensearch` to see the charts.
 
-## Status
+## Change Logs
 
-![Testing](https://github.com/opensearch-project/helm-charts/workflows/Lint%20and%20Test%20Charts/badge.svg)
-![Release](https://github.com/opensearch-project/helm-charts/workflows/Release%20Charts/badge.svg)
+Please review the [OpenSearch](charts/opensearch/CHANGELOG.md) and the
+[OpenSearch Dashboards](charts/opensearch/CHANGELOG.md) change logs for the latest 
+release details.
 
 ## Contributing
 
@@ -46,7 +55,3 @@ If you discover a potential security issue in this project we ask that you notif
 ## License
 
 This project is licensed under the [Apache v2.0 License](LICENSE.txt).
-
-## Copyright
-
-Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.
diff --git a/charts/README.md b/charts/README.md
@@ -1,23 +1,18 @@
 
 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
 
-This chart is tested with the latest 1.0.0 version.
+[OpenSearch Helm chart](https://opensearch.org/docs/opensearch/install/helm/)
 
-* Clone this repo
-* Install it:
-    - with Helm 3: `helm install oss ./Helm/opensearch`
+[OpenSearch Dashboards Helm chart](https://opensearch.org/docs/dashboards/install/helm/)
 
-## Usage notes
+## 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
@@ -38,7 +33,6 @@ This chart is tested with the latest 1.0.0 version.
 ## 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
diff --git a/charts/opensearch-dashboards/CHANGELOG.md b/charts/opensearch-dashboards/CHANGELOG.md
@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+---
+## [1.0.2]
+
+### Added
+- Added this change log in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
+
+### Changed
+- Incremented the version to `1.0.2`.
+
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+[Unreleasedd]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.2...HEAD
+[opensearch-dashboards-1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.1...opensearch-dashboards-1.0.2
diff --git a/charts/opensearch-dashboards/Chart.yaml b/charts/opensearch-dashboards/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.0.1
+version: 1.0.2
 
 # 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/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+---
+## [1.0.2]
+
+### Added
+- Added this change log in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
+
+### Changed
+- Incremented the version to `1.0.2`.
+
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...HEAD
+[1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.1...opensearch-1.0.2
diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: opensearch
-description: A Helm chart for Kubernetes
+description: A Helm chart for OpenSearch
 
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -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.0.1
+version: 1.0.2
 
 # 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
@@ -24,7 +24,6 @@ To install the chart with the release name `my-release`:
 -  Install using Helm 2
 `❯ helm install --name my-release opensearch-1.0.0.tgz`
 
-
 The command deploys OpenSearch with its associated components (data statefulsets, masters, clients) on the Kubernetes cluster in the default configuration.
 
 ## Uninstalling