Skip to content

docs: add readme.md for helm charts #534

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.

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
Apr 11, 2025
Merged
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions charts/kubevpn/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Helm charts for KubeVPN server

Use helm to install kubevpn server means use cluster mode. All user will use this instance.

- Please make sure users should have permission to namespace `kubevpn`.
- Otherwise, will fall back to create `kubevpn` deployment in own namespace.

## Install with default mode

```shell
helm install kubevpn kubevpn/kubevpn -n kubevpn --create-namespace
```

in China, you can use tencent image registry

```shell
helm install kubevpn kubevpn/kubevpn --set image.repository=ccr.ccs.tencentyun.com/kubevpn/kubevpn -n kubevpn --create-namespace
```

## AWS Fargate cluster

```shell
helm install kubevpn kubevpn/kubevpn --set netstack=gvisor -n kubevpn --create-namespace
```
Loading