Skip to content

Commit

Permalink
Merge pull request #2 from Project-HAMi/docs/update-chart-readme
Browse files Browse the repository at this point in the history
docs(chart/hami-webui): update README.md with latest chart information
  • Loading branch information
Nimbus318 authored Oct 8, 2024
2 parents f6423e4 + 0266109 commit fb5e120
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions charts/hami-webui/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
# HAMi-WebUI

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
![Version: 1.0.2](https://img.shields.io/badge/Version-1.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.2](https://img.shields.io/badge/AppVersion-1.0.2-informational?style=flat-square)

## Get Repo Info

```console
helm repo add hami-charts https://project-hami.github.io/HAMi/
helm repo add hami-webui https://project-hami.github.io/HAMi-WebUI
helm repo update
```

_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._

## Installing the Chart

To install the chart with the release name `my-release`:
Before deploying, ensure that you configure the `values.yaml` file to match your cluster’s requirements. For detailed instructions, refer to the [Configuration Guide for HAMi-WebUI Helm Chart](#configuration-guide-for-hamiwebui-helm-chart)
> _**Important**_: You must adjust the values.yaml before proceeding with the deployment.
Download the `values.yaml` file from the Helm Charts repository:

https://github.com/Project-HAMi/HAMi-WebUI/blob/main/charts/hami-webui/values.yaml


```console
helm install hami-webui hami-charts/hami-webui
helm install my-hami-webui hami-webui/hami-webui --create-namespace --namespace hami -f values.yaml
```

## Uninstalling the Chart

To uninstall/delete the my-release deployment:

```console
helm delete hami-webui
helm delete my-hami-webui
```

The command removes all the Kubernetes components associated with the chart and deletes the release.
Expand Down

0 comments on commit fb5e120

Please sign in to comment.