Skip to content

Commit 43e2bb1

Browse files
authored
Merge pull request #215 from Eeshu-Yadav/issue-181/version-specific-install
docs: improve versioned Helm chart installation
2 parents 131964d + 6d37278 commit 43e2bb1

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/setup/quick-start.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,26 @@ You can install Kmesh directly from the GitHub Container Registry without clonin
9393
helm install kmesh oci://ghcr.io/kmesh-net/kmesh-helm --version x.y.z -n kmesh-system --create-namespace
9494
```
9595

96-
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`).
96+
- Replace `x.y.z` with your desired version from [kmesh-helm packages](https://github.com/orgs/kmesh-net/packages/container/package/kmesh-helm):
97+
- For stable releases, use a version like `v1.1.0`.
98+
- For pre-releases, use a version like `v1.1.0-alpha`.
99+
- Omit the `--version` flag to install the latest version (not recommended for production).
97100

98101
### Option 2: Install from Helm
99102

100103
```shell
101104
helm install kmesh ./deploy/charts/kmesh-helm -n kmesh-system --create-namespace
102105
```
103106

104-
### Option 3: Install from Yaml
107+
### Option 3: Install from Helm Chart Archive
108+
109+
```shell
110+
helm install kmesh ./kmesh-helm-<version>.tgz -n kmesh-system --create-namespace
111+
```
112+
113+
- Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command above with the version you downloaded (e.g., `v1.1.0`).
114+
115+
### Option 4: Install from Yaml
105116

106117
```shell
107118
kubectl create namespace kmesh-system
@@ -287,7 +298,7 @@ Annotations: <none>
287298

288299
### Delete Kmesh
289300

290-
If you installed Kmesh using helm or OCI registry:
301+
If you installed Kmesh using any of the Helm options above:
291302

292303
```shell
293304
helm uninstall kmesh -n kmesh-system

0 commit comments

Comments
 (0)