Skip to content

docs: Update install docs to use Helm OCI registry #277

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

Open
imshubham22apr-gif wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −9
Open

docs: Update install docs to use Helm OCI registry #277

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
30 changes: 21 additions & 9 deletions docs/setup/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,36 +83,48 @@

## Install Kmesh

We offer several ways to install Kmesh:
The recommended way to install Kmesh is via Helm from the OCI registry. This method is the simplest and doesn't require cloning the repository.

### Option 1: Install from OCI Registry (Recommended)

You can install Kmesh directly from the GitHub Container Registry without cloning the repository:
You can install Kmesh directly from the GitHub Container Registry:

```shell
helm install kmesh oci://ghcr.io/kmesh-net/kmesh-helm --version x.y.z -n kmesh-system --create-namespace
helm install kmesh oci://ghcr.io/kmesh-net/kmesh-helm --version v1.2.0 -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):
- For other versions, refer to the [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`.
Comment on lines 97 to 98
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The main command on line 93 uses version v1.2.0, but the examples for stable and pre-releases here refer to v1.1.0 and v1.1.0-alpha. To improve consistency and avoid potential confusion for users, it would be better to update these examples to align with the version used in the main command.

Suggested change
- For stable releases, use a version like `v1.1.0`.
- For pre-releases, use a version like `v1.1.0-alpha`.
- For stable releases, use a version like `v1.2.0`.
- For pre-releases, use a version like `v1.2.0-alpha`.

- Omit the `--version` flag to install the latest version (not recommended for production).

### Option 2: Install from Helm
---

### Alternative: Install from Source (For Developers)
Copy link
Copy Markdown
Member

@hzxuzhonghu hzxuzhonghu Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the comments from copilot, it has option1 but no option 2


If you're a developer and need to install from a local source code directory or require more customization, use one of the following methods.

Check failure on line 105 in docs/setup/quick-start.md

View workflow job for this annotation

GitHub Actions / build (1.23)

Trailing spaces 

docs/setup/quick-start.md:105:142 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md

> **Note**: These methods require you to clone the [Kmesh repository](https://github.com/kmesh-net/kmesh) first:
> ```shell

Check failure on line 108 in docs/setup/quick-start.md

View workflow job for this annotation

GitHub Actions / build (1.23)

Fenced code blocks should be surrounded by blank lines 

docs/setup/quick-start.md:108 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "> ```shell"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md
> git clone https://github.com/kmesh-net/kmesh.git
> cd kmesh
> ```
Comment on lines +107 to +111

#### Method 1: Install from Helm (Local Source)

```shell
helm install kmesh ./deploy/charts/kmesh-helm -n kmesh-system --create-namespace
```

### Option 3: Install from Helm Chart Archive
#### Method 2: Install from Helm Chart Archive

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.2.0`).
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This instruction refers to "the command above", but the relevant command block is actually located below this line. To prevent confusion, please change "above" to "below".

Suggested change
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.2.0`).
Download the `kmesh-helm-<version>.tgz` archive from [GitHub Releases](https://github.com/kmesh-net/kmesh/releases). Replace `<version>` in the command below with the version you downloaded (e.g., `v1.2.0`).


```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
#### Method 3: Install from Yaml

```shell
kubectl create namespace kmesh-system
Expand Down
Loading