Skip to content

Commit

Permalink
docs: update install step docs
Browse files Browse the repository at this point in the history
Signed-off-by: yutao04 <yutao04@corp.netease.com>
  • Loading branch information
trickMin committed Nov 1, 2022
1 parent 2d4aade commit 19d902d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
10 changes: 6 additions & 4 deletions install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@

We use helm to install gateway on kubernetes. If you do not have a kubernetes, you can start with [minikube start](https://minikube.sigs.k8s.io/docs/start/)

Kubernetes Version >=1.17
1.22 > Kubernetes Version >=1.17

### Install with Shell

1. Go to the "hango-gateway/install" directory. The directory structure tree is as follows
1. Go to github hango-gateway's [releases page](https://github.com/hango-io/hango-gateway/releases) to download the latest version: [release-v1.0.0](https://github.com/hango-io/hango-gateway/releases/download/v1.0.0/hango-gateway-v1.0.0.zip), then decompress the zip file to a local directory

2. Go to the "hango-gateway/install" directory. The directory structure tree is as follows
```xml
install
install
Expand All @@ -20,13 +22,13 @@ install
├─check.sh
└─uninstall.sh
```
2. You will see three scripts for install (install.sh), check status (check.sh), and uninstall (uninstall.sh) respectively. You can directly execute the command
3. You will see three scripts for install (install.sh), check status (check.sh), and uninstall (uninstall.sh) respectively. You can directly execute the command

Note: Make sure you have sufficient permissions before executing the script
```shell
sh install.sh
```
3. After the script is executed, run the following command to verify the running status of the Hango gateway
4. After the script is executed, run the following command to verify the running status of the Hango gateway
```shell
sh check.sh
```
Expand Down
10 changes: 6 additions & 4 deletions install/README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

## 前置条件

1.目前版本支持基于Kubernetes进行安装,如果没有Kubernetes环境,可以采用[minikube](https://minikube.sigs.k8s.io/docs/start/) 进行安装。对于Kubernetes的版本,我们要求版本至少是1.17 版本。\
1.目前版本支持基于Kubernetes进行安装,如果没有Kubernetes环境,可以采用[minikube](https://minikube.sigs.k8s.io/docs/start/) 进行安装。对于Kubernetes的版本,我们要求版本至少是1.17 版本,低于1.22 版本\
2.请确保已安装helm。

### 安装hango网关

1、进入"hango-gateway/install"目录下,目录结构树如下
1、前往github hango-gateway的[releases界面](https://github.com/hango-io/hango-gateway/releases)下载最新的[release-v1.0.0版本](https://github.com/hango-io/hango-gateway/releases/download/v1.0.0/hango-gateway-v1.0.0.zip),将压缩包解压为本地目录

2、进入"hango-gateway/install"目录下,目录结构树如下
```xml
install
├─common
Expand All @@ -18,12 +20,12 @@ install
├─check.sh
└─uninstall.sh
```
2、您将看到3个脚本分别用于安装(install.sh)、检查状态(check.sh)、卸载(uninstall.sh),可直接执行命令\
3、您将看到3个脚本分别用于安装(install.sh)、检查状态(check.sh)、卸载(uninstall.sh),可直接执行命令\
注意:在脚本执行前请确保权限足够
```shell
sh install.sh
```
3、等待脚本执行完毕后,可以通过执行下面的命令查看hango网关的运行状态
4、等待脚本执行完毕后,可以通过执行下面的命令查看hango网关的运行状态
```shell
sh check.sh
```
Expand Down

0 comments on commit 19d902d

Please sign in to comment.