Skip to content

Commit

Permalink
feat: add helm install to quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
fengcaiwen committed Feb 15, 2024
1 parent 7ac91d2 commit 10ef6e4
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
34 changes: 34 additions & 0 deletions website/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,38 @@ network, remote kubernetes cluster service can also access your local service. a
on local Docker container with same environment、volume、and network. you can develop your application on local PC
totally.

# Install server

you can install kubevpn server previously (it will automatically install by kubevpn by command `kubevpn connect`)

```shell
➜ helm repo add kubevpn https://raw.githubusercontent.com/kubenetworks/kubevpn/master/charts
"kubevpn" has been added to your repositories
```

```shell
➜ helm search repo kubevpn
NAME CHART VERSION APP VERSION DESCRIPTION
kubevpn/kubevpn 2.2.2 v2.2.2 A Helm chart for KubeVPN
```

```shell
~ helm install kubevpn kubevpn/kubevpn
NAME: kubevpn
LAST DEPLOYED: Thu Feb 15 21:36:57 2024
NAMESPACE: test
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Connect to cluster network by running these commands:
kubevpn connect --namespace test
export POD_IP=$(kubectl get pods --namespace test -l "app.kubernetes.io/name=kubevpn,app.kubernetes.io/instance=kubevpn" -o jsonpath="{.items[0].status.podIP}")
ping $POD_IP
```

# Install client

## Install from GitHub release

[LINK](https://github.com/kubenetworks/kubevpn/releases/latest)
Expand All @@ -32,6 +64,8 @@ totally.

```

## Install kubevpn-traffic-manager in cluster

## Install bookinfo as demo application

```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,43 @@ sidebar_position: 1

# 快速开始

KubeVPN 是一个云原生开发工具, 可以在本地连接云端 kubernetes 网络的工具,可以在本地直接访问远端集群的服务。也可以在远端集群访问到本地服务,便于调试及开发。同时还可以使用开发模式,直接在本地使用 Docker 将远程容器运行在本地。
KubeVPN 是一个云原生开发工具, 可以在本地连接云端 kubernetes
网络的工具,可以在本地直接访问远端集群的服务。也可以在远端集群访问到本地服务,便于调试及开发。同时还可以使用开发模式,直接在本地使用
Docker 将远程容器运行在本地。

# 安装 kubevpn server

可以通过 helm 安装 server,如下命令:

```shell
➜ helm repo add kubevpn https://raw.githubusercontent.com/kubenetworks/kubevpn/master/charts
"kubevpn" has been added to your repositories
```

```shell
➜ helm search repo kubevpn
NAME CHART VERSION APP VERSION DESCRIPTION
kubevpn/kubevpn 2.2.2 v2.2.2 A Helm chart for KubeVPN
```

```shell
~ helm install kubevpn kubevpn/kubevpn
NAME: kubevpn
LAST DEPLOYED: Thu Feb 15 21:36:57 2024
NAMESPACE: test
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
1. Connect to cluster network by running these commands:
kubevpn connect --namespace test
export POD_IP=$(kubectl get pods --namespace test -l "app.kubernetes.io/name=kubevpn,app.kubernetes.io/instance=kubevpn" -o jsonpath="{.items[0].status.podIP}")
ping $POD_IP
```

当 client 链接时,如果 server 没有安装,client 将会自动安装 server

# 安装 kubevpn client

## 从 Github release 下载编译好的二进制文件

Expand Down

0 comments on commit 10ef6e4

Please sign in to comment.