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. +[![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. diff --git a/charts/ozone/README.md b/charts/ozone/README.md index 7d21dcd..07c54aa 100644 --- a/charts/ozone/README.md +++ b/charts/ozone/README.md @@ -23,12 +23,29 @@ ## 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+ +- 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 +``` ## Documentation