Update Readme

README.md

@@ -1,2 +1,23 @@
-# charts
-Collection of OKDP helm charts
+[![ci](https://github.com/okdp/charts/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/spark-history-server/actions/workflows/ci.yml)
+[![release-please](https://github.com/okdp/charts/actions/workflows/release-please.yml/badge.svg)](https://github.com/okdp/spark-history-server/actions/workflows/release-please.yml)
+[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+
+<p align="center">
+    <img width="400px" height=auto src="https://okdp.io/logos/okdp-inverted.png" />
+</p>
+
+
+A Helm chart for the [Spark History Server](https://spark.apache.org/docs/latest/monitoring.html#viewing-after-the-fact).
+
+## Installation
+
+Refer to [README](helm/spark-history-server/README.md) for the customization and installation guide.
+
+## Requirements
+
+- Kubernetes cluster
+- [Helm](https://helm.sh/) installed
+
+> [!NOTE]
+> An OKDP sandbox, with all these helm charts installed, is under development and you can use it once released.
+> 

helm/spark-history-server/README.md.gotmpl

@@ -15,27 +15,17 @@ This chart bootstraps a [Spark History Server](https://spark.apache.org/docs/lat
 
 ## Installing the chart
 
-To deploy the chart with a release name `my-release`:
-
-1. First, add the okdp helm charts repository:
-
-```shell
-$ helm repo add okdp https://okdp.github.io/charts
-```
-
-2. Then, install the chart with the release name `my-release`:
+To install the chart with the release name `my-release`:
 
 ```shell
-$ helm install --version {{ template "chart.version" . }} \
-  my-release okdp/spark-history-server
+$ helm install my-release oci://quay.io/okdp/charts/spark-history-server --version {{ template "chart.version" . }}
 ```
 
-This will create a release of `my-release` in the default namespace. To install in a different one:
+This will create a release of `my-release` in the default namespace. To install in a different namespace:
 
 ```shell
-$ helm install --version {{ template "chart.version" . }} \
-  --namespace spark \
-  my-release okdp/spark-history-server
+$ helm install my-release oci://quay.io/okdp/charts/spark-history-server --version {{ template "chart.version" . }} \
+       --namespace spark 
 ```
 
 Note that `helm` will fail to install if the namespace doesn't exist. Either create the namespace beforehand or pass the `--create-namespace` flag to the `helm install` command.
@@ -49,6 +39,15 @@ $ helm uninstall my-release -n spark
 ```
 
 The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Downloading the chart locally
+
+To download the chart locally, use the following command:
+
+```shell
+$ helm pull oci://quay.io/okdp/charts/spark-history-server --version {{ template "chart.version" . }}
+```
+
 ## Configuration examples
 
 ### Using an S3-Compatible System for Log Storage
@@ -99,11 +98,9 @@ extraEnvs:
 ##### 3. Deploy the Helm Chart
 
 ```shell
-helm repo add okdp https://okdp.github.io/charts
-helm install --version {{ template "chart.version" . }} \
-  --namespace spark \
-  --values my-values.yaml \
-  my-release okdp/spark-history-server
+helm install my-release oci://quay.io/okdp/charts/spark-history-server --version {{ template "chart.version" . }} \
+      --namespace spark \
+      --values my-values.yaml \
 ```