Add example using helm repo to helm installation guide (#3517)

* Add example using helm repo to helm installation guide * Update charts/kueue/README.md Co-authored-by: Mykhailo Bobrovskyi <[email protected]> * Add kueue README.md to version replace sed * Fix sed replace for kueue helm readme * Remove kueue readme from other sed --------- Co-authored-by: Mykhailo Bobrovskyi <[email protected]>
kubernetes-sigs · Nov 13, 2024 · 00a05fc · 00a05fc
1 parent 140e9dd
commit 00a05fc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -280,6 +280,7 @@ artifacts: kustomize yq helm ## Generate release artifacts.
 .PHONY: prepare-release-branch
 prepare-release-branch: yq kustomize ## Prepare the release branch with the release version.
 	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml
+	$(SED) -r 's/--version="v[0-9]+\.[0-9]+\.[0-9]+/--version="$(RELEASE_VERSION)/g' -i charts/kueue/README.md
 	$(YQ) e '.appVersion = "$(RELEASE_VERSION)"' -i charts/kueue/Chart.yaml
 	@$(call clean-manifests)
 

diff --git a/charts/kueue/README.md b/charts/kueue/README.md
@@ -24,12 +24,20 @@ Quick start instructions for the setup and configuration of kueue using Helm.
 
 ##### Install chart using Helm v3.0+
 
+Either clone the kueue repository:
+
 ```bash
 $ git clone [email protected]:kubernetes-sigs/kueue.git
 $ cd kueue/charts
 $ helm install kueue kueue/ --create-namespace --namespace kueue-system
 ```
 
+Or use the charts pushed to `us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue`:
+
+```bash
+helm install kueue oci://us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue --version="v0.9.0" --create-namespace --namespace=kueue-system
+```
+
 ##### Verify that controller pods are running properly.
 
 ```bash