This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ozone-helm-charts.git
The following commit(s) were added to refs/heads/main by this push:
new 3616a3e HDDS-11039. Release initial version of the Helm chart (#4)
3616a3e is described below
commit 3616a3e1e0e921ff76e1b561d190e94e7dcb9cd4
Author: Denis Krivenko <[email protected]>
AuthorDate: Wed Oct 9 19:10:19 2024 +0200
HDDS-11039. Release initial version of the Helm chart (#4)
---
.github/actions/chart-releaser-action | 1 +
.github/workflows/release.yaml | 31 +++++++++++++++++++++++++++++++
.gitmodules | 3 +++
README.md | 28 +++++++++++++++++++++++++++-
charts/ozone/README.md | 29 ++++++++++++++++++++++++++---
5 files changed, 88 insertions(+), 4 deletions(-)
diff --git a/.github/actions/chart-releaser-action
b/.github/actions/chart-releaser-action
new file mode 160000
index 0000000..a917fd1
--- /dev/null
+++ b/.github/actions/chart-releaser-action
@@ -0,0 +1 @@
+Subproject commit a917fd15b20e8b64b94d9158ad54cd6345335584
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
new file mode 100644
index 0000000..05335fe
--- /dev/null
+++ b/.github/workflows/release.yaml
@@ -0,0 +1,31 @@
+name: Release Charts
+
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ persist-credentials: false
+ submodules: recursive
+
+ - name: Configure Git
+ run: |
+ git config user.name "$GITHUB_ACTOR"
+ git config user.email "[email protected]"
+
+ - name: Run chart-releaser
+ uses: ./.github/actions/chart-releaser-action
+ env:
+ CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+ CR_GENERATE_RELEASE_NOTES: true
+ CR_SKIP_EXISTING: true
diff --git a/.gitmodules b/.gitmodules
index 1d724ec..55c4ce5 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -20,3 +20,6 @@
[submodule ".github/actions/kind-action"]
path = .github/actions/kind-action
url = https://github.com/helm/kind-action
+[submodule ".github/actions/chart-releaser-action"]
+ path = .github/actions/chart-releaser-action
+ url = https://github.com/helm/chart-releaser-action
diff --git a/README.md b/README.md
index f924287..789d8f2 100644
--- a/README.md
+++ b/README.md
@@ -17,4 +17,30 @@
# Helm charts for Apache Ozone
-This repository will provide Helm charts for installing Apache Ozone on
Kubernetes.
+[](https://opensource.org/licenses/Apache-2.0)
+
+This repository provides Helm charts for installing Apache Ozone on Kubernetes.
+
+## Helm charts repository
+Use the following command to add the repository to Helm client configuration:
+```shell
+helm repo add ozone https://apache.github.io/ozone-helm-charts/
+```
+List the latest stable versions of available Helm charts with the commands:
+```shell
+helm repo update ozone
+helm search repo ozone
+```
+
+## Contributing
+
+All contributions are welcome.
+Please open a [Jira](https://issues.apache.org/jira/projects/HDDS/issues)
issue and create a pull request.
+
+For more information, please check the [Contribution
guideline](https://github.com/apache/ozone/blob/master/CONTRIBUTING.md).
+
+## License
+
+The Apache Ozone project is licensed under the Apache 2.0 License.
+
+See the [LICENSE](./LICENSE) file for details.
diff --git a/charts/ozone/README.md b/charts/ozone/README.md
index 7d21dcd..6dc6806 100644
--- a/charts/ozone/README.md
+++ b/charts/ozone/README.md
@@ -23,12 +23,35 @@
## Introduction
-This chart bootstraps an [Ozone](https://ozone.apache.org) deployment on a
[Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh)
package manager.
+This chart bootstraps an [Apache Ozone](https://ozone.apache.org) deployment
on a [Kubernetes](http://kubernetes.io) cluster using the
[Helm](https://helm.sh) package manager.
## Requirements
-- Kubernetes cluster 1.27+
-- Helm 3.0+
+- Kubernetes cluster 1.29+
+- Helm 3
+
+## Helm charts repository
+Use the following command to add the repository to Helm client configuration:
+```shell
+helm repo add ozone https://apache.github.io/ozone-helm-charts/
+```
+
+## Installing the chart
+Install the chart with `ozone` release name:
+```shell
+helm install ozone ozone/ozone
+```
+
+## Uninstalling the chart
+```shell
+helm uninstall ozone
+```
+
+## Configuration
+Refer default `values.yaml` file of the chart for all the possible
configuration properties:
+```shell
+helm show values ozone/ozone
+```
## Documentation
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
