From 6d372785b37984125a7dd203d7bb037b8ac65484 Mon Sep 17 00:00:00 2001 From: Eeshu-Yadav Date: Tue, 5 Aug 2025 13:42:51 +0530 Subject: [PATCH] docs: improve versioned Helm chart installation Signed-off-by: Eeshu-Yadav --- docs/setup/quick-start.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/setup/quick-start.md b/docs/setup/quick-start.md index f2bfebd3..561d39f8 100644 --- a/docs/setup/quick-start.md +++ b/docs/setup/quick-start.md @@ -93,7 +93,10 @@ You can install Kmesh directly from the GitHub Container Registry without clonin helm install kmesh oci://ghcr.io/kmesh-net/kmesh-helm --version x.y.z -n kmesh-system --create-namespace ``` -Replace `x.y.z` with your desired version from [kmesh-helm packages](https://github.com/orgs/kmesh-net/packages/container/package/kmesh-helm)(e.g., `v1.1.0`). +- Replace `x.y.z` with your desired version from [kmesh-helm packages](https://github.com/orgs/kmesh-net/packages/container/package/kmesh-helm): + - For stable releases, use a version like `v1.1.0`. + - For pre-releases, use a version like `v1.1.0-alpha`. + - Omit the `--version` flag to install the latest version (not recommended for production). ### Option 2: Install from Helm @@ -101,7 +104,15 @@ Replace `x.y.z` with your desired version from [kmesh-helm packages](https://git helm install kmesh ./deploy/charts/kmesh-helm -n kmesh-system --create-namespace ``` -### Option 3: Install from Yaml +### Option 3: Install from Helm Chart Archive + +```shell +helm install kmesh ./kmesh-helm-.tgz -n kmesh-system --create-namespace +``` + +- Download the `kmesh-helm-.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `` in the command above with the version you downloaded (e.g., `v1.1.0`). + +### Option 4: Install from Yaml ```shell kubectl create namespace kmesh-system @@ -287,7 +298,7 @@ Annotations: ### Delete Kmesh -If you installed Kmesh using helm or OCI registry: +If you installed Kmesh using any of the Helm options above: ```shell helm uninstall kmesh -n kmesh-system