Skip to content

Commit

Permalink
HDDS-11039. Release initial version of the Helm chart (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
dnskr authored Oct 9, 2024
1 parent e55fce3 commit 3616a3e
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/actions/chart-releaser-action
Submodule chart-releaser-action added at a917fd
31 changes: 31 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -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 "$GITHUB_ACTOR@users.noreply.github.com"
- 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
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,30 @@

# Helm charts for Apache Ozone

This repository will provide Helm charts for installing Apache Ozone on Kubernetes.
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](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.
29 changes: 26 additions & 3 deletions charts/ozone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

1 comment on commit 3616a3e

@pyttel
Copy link
Contributor

@pyttel pyttel commented on 3616a3e Oct 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi and thank you for the helm chart!
I tried to install the chart with persistence switched on. I get the following error:

PersistentVolumeClaim "YXZ-datanode" is invalid: spec.accessModes: Required value: at least 1 access mode is required

Would it be fixed if accessModes can be set by values.yaml?

Please sign in to comment.