Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HDDS-11039. Release initial version of the Helm chart #4

Merged
merged 6 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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