From b32e3c60d94766c8f3fe7464d0f99f716798bd7d Mon Sep 17 00:00:00 2001 From: Michael Primeaux Date: Sun, 17 Oct 2021 06:15:26 -0500 Subject: [PATCH] Amended installation instructions (#81) * Amended installation instruction and relaxed linting and testing workflow triggers. Signed-off-by: Michael Primeaux * Minor typographic error. Signed-off-by: Michael Primeaux * - Reverted linting and testing trigger globbing. Signed-off-by: Michael Primeaux * - Added path globbing. Signed-off-by: Michael Primeaux * - Removed path globbing. Signed-off-by: Michael Primeaux * Revert "- Amended CHANGELOGs" This reverts commit e0ab1787c5e5adecc7875c4908eeb11f2ad3214c. * - Bumped chart versions. - Amended CHANGELOGs. Signed-off-by: Michael Primeaux * Incremented opensearcn chart version to 1.0.8 Signed-off-by: Michael Primeaux * - Added specific references to the underlying charts folder from the root-level README. - Addressed clarifications from @TheAlgo. Signed-off-by: Michael Primeaux * - Modified change log for the OpenSearch Helm chart. Signed-off-by: Michael Primeaux --- .github/workflows/lint-test.yaml | 3 +- README.md | 16 ++++++++--- charts/opensearch-dashboards/CHANGELOG.md | 13 ++++++++- charts/opensearch-dashboards/Chart.yaml | 2 +- charts/opensearch-dashboards/README.md | 34 +++++++++++++++++++++++ charts/opensearch/CHANGELOG.md | 28 ++++++++++++++++++- charts/opensearch/Chart.yaml | 2 +- charts/opensearch/README.md | 24 ++++++++-------- ct.yaml | 1 - 9 files changed, 101 insertions(+), 22 deletions(-) create mode 100644 charts/opensearch-dashboards/README.md diff --git a/.github/workflows/lint-test.yaml b/.github/workflows/lint-test.yaml index 0ac454f9..2f7237fe 100644 --- a/.github/workflows/lint-test.yaml +++ b/.github/workflows/lint-test.yaml @@ -1,7 +1,8 @@ +# See https://github.com/helm/chart-testing-action name: Lint and Test Charts on: [pull_request, workflow_dispatch] - + jobs: lint-test: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 25c7068e..c375f4f7 100644 --- a/README.md +++ b/README.md @@ -16,22 +16,30 @@ 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) +[![Lint and Test Charts](https://github.com/opensearch-project/helm-charts/actions/workflows/lint-test.yaml/badge.svg)](https://github.com/opensearch-project/helm-charts/actions/workflows/lint-test.yaml) + [![Release Charts](https://github.com/opensearch-project/helm-charts/actions/workflows/release.yaml/badge.svg)](https://github.com/opensearch-project/helm-charts/actions/workflows/release.yaml) ## 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 ``` -You can then run `helm search repo opensearch` to see the charts. +Once the charts repository reference is added, you can run the following command to see the charts. + +```shell +helm search repo opensearch +``` + +Please see the `README.md` in the [OpenSearch](charts/opensearch) and [OpenSearch Dashboards](charts/opensearch-dashboards) directories for installation instructions. ## Change Logs Please review the [OpenSearch](charts/opensearch/CHANGELOG.md) and the -[OpenSearch Dashboards](charts/opensearch/CHANGELOG.md) change logs for the latest +[OpenSearch Dashboards](charts/opensearch-dashboards/CHANGELOG.md) change logs for the latest release details. ## Contributing diff --git a/charts/opensearch-dashboards/CHANGELOG.md b/charts/opensearch-dashboards/CHANGELOG.md index 1fd3ce20..15089fee 100644 --- a/charts/opensearch-dashboards/CHANGELOG.md +++ b/charts/opensearch-dashboards/CHANGELOG.md @@ -13,6 +13,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed ### Security +--- +## [1.0.5] +### Added +### Changed +- Added [README.md](README.md). +### Deprecated +### Removed +### Fixed +### Security + --- ## [1.0.4] ### Added @@ -37,6 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed ### Security -[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.4...HEAD +[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-1.0.5...HEAD +[1.0.5]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.4...opensearch-1.0.5 [1.0.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...opensearch-1.0.4 [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 index a275e9d3..817d0b32 100644 --- 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.4 +version: 1.0.5 # 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-dashboards/README.md b/charts/opensearch-dashboards/README.md new file mode 100644 index 00000000..12d8162c --- /dev/null +++ b/charts/opensearch-dashboards/README.md @@ -0,0 +1,34 @@ +# OpenSearch Dashboards Helm Chart + + This Helm chart installs [OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards) with configurable TLS, RBAC and much more configurations. This chart caters to a number of different use cases and setups. + + - [Requirements](#requirements) + - [Installing](#installing) + - [Uninstalling](#uninstalling) + + ## Requirements + + * Kubernetes >= 1.14 + * Helm >= 2.17.0 + * We recommend you to have 8 GiB of memory available for this deployment, or at least 4 GiB for the minimum requirement. Else, the deployment is expected to fail. + + ## Installing + + Once you've added this Helm repository as per the repository-level [README](../../README.md#installing) + then you can install the chart as follows: + + ```shell + helm install my-release opensearch/opensearch-dashboards +``` + + The command deploys OpenSearch Dashboards with its associated components on the Kubernetes cluster in the default configuration. + + **NOTE:** If using Helm 2 then you'll need to add the [`--name`](https://v2.helm.sh/docs/helm/#options-21) command line argument. If unspecified, Helm 2 will autogenerate a name for you. + + ## Uninstalling + To delete/uninstall the chart with the release name `my-release`: + + ```shell + helm uninstall my-release + ``` + \ No newline at end of file diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md index bdacfb3e..324755cf 100644 --- a/charts/opensearch/CHANGELOG.md +++ b/charts/opensearch/CHANGELOG.md @@ -12,6 +12,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed ### Fixed ### Security + +--- +## [1.0.8] +### Added +### Changed +- Amended the installation instructions in the `OpenSearch` Helm chart [README](README.md). +- Amended status badges to GitHub-generated markdown. +### Deprecated +### Removed +### Fixed +### Security + --- ## [1.0.6] @@ -32,6 +44,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed ### Security +--- +## [1.0.5] +### Added +### Changed +- Added [Usage Notes](README.md#usage-notes) to `README.md` and amended installation instructions. +### Deprecated +### Removed +### Fixed +### Security + --- ## [1.0.4] ### Added @@ -57,6 +79,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed ### Security -[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.4...HEAD +[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.8...HEAD +[1.0.8]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.7...opensearch-1.0.8 +[1.0.7]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.6...opensearch-1.0.7 +[1.0.6]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.5...opensearch-1.0.6 +[1.0.5]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.4...opensearch-1.0.5 [1.0.4]: https://github.com/opensearch-project/helm-charts/compare/opensearch-1.0.2...opensearch-1.0.4 [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 index 38373731..171bd93f 100644 --- 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.0.7 +version: 1.0.8 # 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 index d0dc7a18..f7835fcc 100644 --- a/charts/opensearch/README.md +++ b/charts/opensearch/README.md @@ -3,8 +3,8 @@ This Helm chart installs [OpenSearch](https://github.com/opensearch-project/OpenSearch) with configurable TLS, RBAC and much more configurations. This chart caters a number of different use cases and setups. - [Requirements](#requirements) -- [Installing the chart](#installing) -- [Uninstalling the chart](#uninstalling) +- [Installing](#installing) +- [Uninstalling](#uninstalling) - [Configuration](#configuration) ## Requirements @@ -15,21 +15,21 @@ This Helm chart installs [OpenSearch](https://github.com/opensearch-project/Open ## Installing -To install the chart with the release name `my-release`: -- Switch to opensearch directly after cloning the repo - `❯ cd charts/opensearch` -- Run `❯ helm package .` -- Install using Helm 3: -`❯ helm install my-release opensearch-1.0.0.tgz` -- Install using Helm 2 -`❯ helm install --name my-release opensearch-1.0.0.tgz` +Once you've added this Helm repository as per the repository-level [README](../../README.md#installing) then you can install the chart as follows: + + ```shell + helm install my-release opensearch/opensearch + ``` The command deploys OpenSearch with its associated components (data statefulsets, masters, clients) on the Kubernetes cluster in the default configuration. +**NOTE:** If using Helm 2 then you'll need to add the [`--name`](https://v2.helm.sh/docs/helm/#options-21) command line argument. If unspecified, Helm 2 will autogenerate a name for you. + ## Uninstalling To delete/uninstall the chart with the release name `my-release`: -``` -❯ helm uninstall my-release + +```shell +helm uninstall my-release ``` ## Configuration diff --git a/ct.yaml b/ct.yaml index 8554b40a..5f24888c 100644 --- a/ct.yaml +++ b/ct.yaml @@ -1,4 +1,3 @@ -# See https://github.com/helm/chart-testing-action # See https://github.com/helm/chart-testing#configuration target-branch: main helm-extra-args: --timeout 800s