Skip to content

docs: improve versioned Helm chart installation #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

docs: improve versioned Helm chart installation #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions docs/setup/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,26 @@ 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

```shell
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-<version>.tgz -n kmesh-system --create-namespace
```

- 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`).

### Option 4: Install from Yaml

```shell
kubectl create namespace kmesh-system
Expand Down Expand Up @@ -287,7 +298,7 @@ Annotations: <none>

### 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
Expand Down