Skip to content

Commit 573269d

Browse files
mprimeauxmprimeaux
authored
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]>
1 parent dd0c692 commit 573269d

File tree

8 files changed

+140
-25
lines changed

8 files changed

+140
-25
lines changed

‎CHANGELOG.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
## [Unreleased]
9+
### Added
10+
### Changed
11+
### Deprecated
12+
### Removed
13+
### Fixed
14+
### Security
15+
16+
---
17+
## [Unreleased-Dashboards]
18+
### Added
19+
### Changed
20+
### Deprecated
21+
### Removed
22+
### Fixed
23+
### Security
24+
25+
---
26+
## [opensearch-1.0.2]
27+
28+
### Added
29+
- Added this changelog in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
30+
31+
### Changed
32+
- Incremented the version to 1.0.2
33+
### Deprecated
34+
### Removed
35+
### Fixed
36+
### Security
37+
38+
---
39+
## [opensearch-dashboards-1.0.2]
40+
41+
### Added
42+
- Added this changelog in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
43+
44+
### Changed
45+
- Incremented the version to 1.0.2
46+
### Deprecated
47+
### Removed
48+
### Fixed
49+
### Security
50+
51+
[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...HEAD
52+
[opensearch-1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.1...opensearch-1.0.2
53+
54+
[Unreleased-Dashboards]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.2...HEAD
55+
[opensearch-dashboards1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.1...opensearch-dashboards-1.0.2

‎README.md‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,38 @@
11
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
22

33
- [OpenSearch Project Helm-Charts](#helm-charts)
4-
- [Installation](#installation)
54
- [Status](#status)
5+
- [Installation](#installation)
6+
- [Change Logs](#change-logs)
67
- [Contributing](#contributing)
78
- [Getting Help](#getting-help)
89
- [Code of Conduct](#code-of-conduct)
910
- [Security](#security)
1011
- [License](#license)
11-
- [Copyright](#copyright)
1212

13-
## OpenSearch Project Helm-Charts
13+
## Helm-Charts
1414

1515
A community repository for Helm Charts of OpenSearch Project.
1616

17+
## Status
18+
19+
![Testing](https://github.com/opensearch-project/helm-charts/workflows/Lint%20and%20Test%20Charts/badge.svg)
20+
![Release](https://github.com/opensearch-project/helm-charts/workflows/Release%20Charts/badge.svg)
21+
1722
## Installation
1823

19-
[OpenSearch Helm chart](https://opensearch.org/docs/opensearch/install/helm/)
24+
```shell
25+
helm repo add opensearch https://opensearch-project.github.io/helm-charts/
26+
helm repo update
27+
```
2028

21-
[OpenSearch Dashboards Helm chart](https://opensearch.org/docs/dashboards/install/helm/)
29+
You can then run `helm search repo opensearch` to see the charts.
2230

23-
## Status
31+
## Change Logs
2432

25-
![Testing](https://github.com/opensearch-project/helm-charts/workflows/Lint%20and%20Test%20Charts/badge.svg)
26-
![Release](https://github.com/opensearch-project/helm-charts/workflows/Release%20Charts/badge.svg)
33+
Please review the [OpenSearch](charts/opensearch/CHANGELOG.md) and the
34+
[OpenSearch Dashboards](charts/opensearch/CHANGELOG.md) change logs for the latest
35+
release details.
2736

2837
## Contributing
2938

@@ -46,7 +55,3 @@ If you discover a potential security issue in this project we ask that you notif
4655
## License
4756

4857
This project is licensed under the [Apache v2.0 License](LICENSE.txt).
49-
50-
## Copyright
51-
52-
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.

‎charts/README.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11

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

4-
54
- [Installing](#installing)
65
- [Usage notes](#usage-notes)
76
- [Configuration](#configuration)
87
- [Future](#Future)
98

10-
11-
129
## Installing
1310

14-
This chart is tested with the latest 1.0.0 version.
11+
[OpenSearch Helm chart](https://opensearch.org/docs/opensearch/install/helm/)
1512

16-
* Clone this repo
17-
* Install it:
18-
- with Helm 3: `helm install oss ./Helm/opensearch`
13+
[OpenSearch Dashboards Helm chart](https://opensearch.org/docs/dashboards/install/helm/)
1914

20-
## Usage notes
15+
## Usage Notes
2116

2217
* The chart deploys a StatefulSet and by default will do an automated rolling
2318
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.
3833
## Configuration
3934
TODO : Write about all the parameters used
4035

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

‎charts/opensearch-dashboards/CHANGELOG.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
## [Unreleased]
9+
### Added
10+
### Changed
11+
### Deprecated
12+
### Removed
13+
### Fixed
14+
### Security
15+
16+
---
17+
## [1.0.2]
18+
19+
### Added
20+
- Added this change log in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
21+
22+
### Changed
23+
- Incremented the version to `1.0.2`.
24+
25+
### Deprecated
26+
### Removed
27+
### Fixed
28+
### Security
29+
30+
[Unreleasedd]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.2...HEAD
31+
[opensearch-dashboards-1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.1...opensearch-dashboards-1.0.2

‎charts/opensearch-dashboards/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 1.0.1
18+
version: 1.0.2
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to

‎charts/opensearch/CHANGELOG.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
## [Unreleased]
9+
### Added
10+
### Changed
11+
### Deprecated
12+
### Removed
13+
### Fixed
14+
### Security
15+
16+
---
17+
## [1.0.2]
18+
19+
### Added
20+
- Added this change log in compliance with [Keep A Change Log](https://keepachangelog.com/en/1.0.0/).
21+
22+
### Changed
23+
- Incremented the version to `1.0.2`.
24+
25+
### Deprecated
26+
### Removed
27+
### Fixed
28+
### Security
29+
30+
[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...HEAD
31+
[1.0.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.1...opensearch-1.0.2

‎charts/opensearch/Chart.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: opensearch
3-
description: A Helm chart for Kubernetes
3+
description: A Helm chart for OpenSearch
44

55
# A chart can be either an 'application' or a 'library' chart.
66
#
@@ -15,7 +15,7 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 1.0.1
18+
version: 1.0.2
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to

‎charts/opensearch/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ To install the chart with the release name `my-release`:
2424
- Install using Helm 2
2525
`❯ helm install --name my-release opensearch-1.0.0.tgz`
2626

27-
2827
The command deploys OpenSearch with its associated components (data statefulsets, masters, clients) on the Kubernetes cluster in the default configuration.
2928

3029
## Uninstalling

0 commit comments

Comments
 (0)