diff --git a/README.md b/README.md index fcfa744..8671074 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,65 @@ -# Charts - -# How to ... +# Helm Chart for General Purpose Application Deployment -## Release new chart version +## Introduction + +This repository contains a collection of Helm charts for deploying and managing various applications on Kubernetes. + +## Usage + +### Installing a Chart + +To install a chart from this repository, first add the repository to your Helm client: + +```bash +helm repo add browol https://github.com/browol/helm-charts.git +``` + +Once the repository is added, you can install a chart using its name: + +```bash +helm install browol/general-purpose +``` + +Replace `` with the name of the chart you want to install. + +### Updating a Chart + +To update an existing chart, first upgrade your Helm client: + +```bash +helm upgrade --install browol/general-purpose +``` + +Replace `` with the name of the chart you want to update. + +### Releasing a New Chart Version + +1. Bump the chart version in `Chart.yaml`: -Chart versioning in Chart.yaml ```yaml version: # <<<< Bump version here ``` -Lint the chart +2. Lint the chart: + ```bash helm lint ./ ``` -Create the Helm chart package +3. Create the Helm chart package: + ```bash helm package ./ -d packages/ ``` -Update the Helm chart repository index +4. Update the Helm chart repository index: + ```bash helm repo index --url ./ --merge index.yaml ./ ``` -Push the git repository on GitHub +5. Push the changes to the git repository on GitHub: + ```bash git add . && \ git commit -m "your commit message" && \