update 3.0.0

2ea8b2f1 · eoLinker API Management · 561f9ed0 · 2ea8b2f1
隐藏空白更改
内联并排

Showing with 55 addition and 92 deletion

README.md README.md +55 -92

未找到文件。
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@ Goku API Gateway 的社区版本（CE）拥有完善的使用指南和二次开
 > 建议控制台与节点分别部署在不同的服务器上，一般一台服务器/虚拟机部署一个网关节点。
 > 若要使用多个网关节点，需要将节点文件放置进多台服务器，并且在控制台新建多个节点。
-> 此处为编译版本（release）的部署指南，点击查看：[源码版本（source_code）的部署指南](https://help.eolinker.com/#/tutorial/?groupID=c-346&productID=19 "点击源码版本（source_code）的部署指南")
+> 此处网关控制台与节点的部署指南，点击查看：[源码编译教程](https://help.eolinker.com/#/tutorial/?groupID=c-350&productID=19 "源码编译")
 ### 环境准备
 * **linux系统，内核版本 2.6.23+**
@@ -52,48 +52,22 @@ Goku API Gateway 的社区版本（CE）拥有完善的使用指南和二次开
 * **net-tools**
 * **golnag12.x**
-### 安装文件描述
+### 控制台安装
-AGW的安装包包含两个文件 **goku-console（控制台安装包）** 和 **goku-node（网关节点安装包）**。
+1.安装:
-一、goku-console（控制台安装包）里文件目录如下
-| 目录名称  | 含义  |
-| ------------ | ------------ |
-| goku-ce-console  | 编译后的网关控制台文件 |
-| goku-sql| mysql数据库安装脚本  |
-其中goku-ce-console（控制台文件）里包含一个程序：
-* gateway-console：控制台程序
-二、goku-node（网关节点安装包）里文件目录如下
-| 目录名称  | 含义  |
-| ------------ | ------------ |
-| goku-ce-node  | 编译后的网关节点文件 |
-其中goku-ce-node（节点文件）里包含一个程序：
-* gateway-node：节点程序
-### 安装数据库
-1. 新建数据库goku_ce
-2. 进入goku-console>>goku-sql文件夹，将goku_ce.sql导入到数据库
-```
-mysql -u <用户名> -p<密码> <./goku_ce.sql
 ```
+  mkdir -p {install dir}
+  mv console-{version}.tar.gz {tmp}/
+  cd {tmp}/
+  tar -xzf console-{version}.tar.gz
+  cd console-{version} && ./install.sh {install dir}
+  cd {install dir}
-### 安装控制台
+```
-#### 1. 编辑控制台配置文件
-进入goku-ce-console/config文件夹：cd goku-ce-console/config ，编辑控制台的 **goku.conf** 文件，文件配置编辑语法参照yaml。
+2.首次安装进入{install dir}/console/config文件夹，编辑配置文件内容，配置语法参照yaml
-通过写控制台的goku.conf配置文件，控制台后端可以知道远程数据库相关信息及监听的端口号：
+**goku.conf** 如下：
-```
-    vi goku.conf
-```
-控制台的goku.conf文件配置字段如下：
 ```
 admin_bind: 绑定节点获取配置的地址，形如IP:Port，填写内网地址或本机地址
 listen_port: 管理后台监听端口，可以开放给外网访问
@@ -102,12 +76,9 @@ db_port: 数据库监听端口
 db_name: 数据库名称
 db_user: 登录数据库的用户名
 db_password: 登录数据库的密码
 ```
-#### 2. 编辑网关集群的yaml配置文件
+**cluster.yaml** 配置示例如下：
-该文件放置在**goku-ce-console/config**目录，cluster.yaml的配置示例：
 ```
 cluster:
  -
@@ -145,57 +116,51 @@ cluster:
      dbIndex: 0
 ```
-#### 3. 启动控制台
+3.初次安装创建数据库goku_ce，并运行{install dir}/console/sql文件夹下的goku_ce.sql，执行数据库脚本：
-启动控制台前，需要先给予对应文件正确的权限：
-（1）进入goku-ce-console文件夹，给予 **gateway-console** 文件执行权限：
-    chmod +x gateway-console
-（2）进入goku-ce-console文件夹，给予 **export** 文件夹执行权限：
-    chmod -R 777 export
-然后通过以下命令在后台执行gateway-console（首次执行加上用户名及密码参数）
-* 首次安装
 ```
-nohup ./gateway-console -u admin -p 123456 > gateway-console-"$(date "+%Y-%m-%d_%H_%M_%S")".log 2>&1 &
+mysql -u用户名 -p密码  {install dir}/console/sql/goku_ce.sql
 ```
-**注**：**-u**后加**管理员用户名**，**-p**后加**管理员密码**，管理员账号信息用于登录网关控制台，请注意妥善保管。
-* 非首次安装
+4.进入{install dir}/console文件夹，运行run.sh文件以启动控制台
+**首次运行**：
 ```
-nohup ./gateway-console > gateway-console-"$(date "+%Y-%m-%d_%H_%M_%S")".log 2>&1 &
+.run.sh start {config file} 管理员账号 管理员密码
 ```
-#### 4. 访问控制台
+示例：
+```
+.run.sh start config/goku.conf admin 123456
+```
-在浏览器中输入**IP/域名+端口号**，进入网关控制台页面：
+**非首次运行**：
+```
+.run.sh start|restart
+```
-注：控制台的端口号为 **goku.conf** 中的 **listen_port** 字段
+5.在浏览器输入服务器IP+程序监听端口号，进入管理后台页面
-![](http://data.eolinker.com/course/bNrMsZs20920fa41cd6b3fd5fee98c7e23d76e0922978af)
+注：程序监听端口号为goku.conf的配置项listen_port的值
-至此，您已成功安装好GoKu网关控制台。
+![](http://data.eolinker.com/course/nh4Xc8v24059c115375a87de682a0990ba723916923196f)
-### 安装单个网关节点
+至此控制台已安装完成，在控制台新建节点后，需要通过命令行启动节点。
-#### 1. 服务器导入节点安装包
-（1）将获得的节点安装包压缩文件goku-node导入到服务器中。
+### 节点安装
-（2）给予gateway-node可执行权限：
+1.安装：
 ```
-chmod +x gateway-node
+  mkdir -p {install dir}
+  mv goku-node-{version}.tar.gz {tmp}/
+  cd {tmp}/
+  tar -xzf goku-node-{version}.tar.gz
+  cd goku-node-{version} && ./install.sh {install dir}
+  cd {install dir}
 ```
-其他节点操作类似，先在相应服务器放置网关文件，然后按照第2步依次在控制台新增并启动网关节点。
+2.在管理后台新建节点
-#### 2.在控制台添加并启动节点
 （1）登录控制台，点击一级导航的 **集群管理**，进入相应的集群：
@@ -205,35 +170,33 @@ chmod +x gateway-node
 ![](http://data.eolinker.com/course/rlWf1dI806427cc64c4b73af34dba35a758a4d9f21e86fc)
-（3）添加节点需要填写以下信息：
+（3）点击 **新增节点** 按钮，填写节点信息后点击 **确定**：
-* 选择分组
+>（a）新建节点时的节点IP字段填写内网IP或本地IP  
-* 网关文件路径：可获取到**goku-node**已编译文件的目录，一般放置在**goku-ce-node**目录下
+>（b）若配置文件（goku.conf）中的admin_bind字段值IP部分为127.0.0.1或localhost，此处节点IP必须填写127.0.0.1
-* 节点名称：用于标识服务器节点名称
-* 节点IP：受控节点IP
-* 节点端口：网关受控端监听的端口
-> 注意事项：
+![](http://data.eolinker.com/course/S2Zjkdi511ae476f039aa53059e26a8b675458fb29841fc)
-> **节点IP**字段填写**内网IP或本地IP**
-> 若配置文件（goku.conf）中的**admin_bind**字段值IP部分为**127.0.0.1**或**localhost**，此处节点IP必须填写**127.0.0.1**
-（4）启动节点：
+3.启动节点程序：
-节点新建成功后处于 **未运行** 的状态，如需节点生效需要手动启动节点：
 ```
-./run.sh {start|stop|reload|restart|force-reload} [admin url] [port]
+ {install dir}/run.sh {start|stop|reload|restart|force-reload} [admin url] [port]
 ```
-此处的**admin url**值与配置文件（goku.conf）中的**admin_bind**字段值一致。
+此处的admin url值与配置文件（goku.conf）中的admin_bind字段值一致。
 示例：
 ```
-./run.sh start 127.0.0.1:7005 7702
+ {install dir}/run.sh start 127.0.0.1:7005 7702
 ``` 
-启动后，进入节点管理页面，若节点的状态显示为 **运行中**，则节点正常启动：
+4.检查节点是否正常运行：
+进入节点管理页面，若节点的状态显示为运行中，则节点正常启动：
+![](http://data.eolinker.com/course/WelR3FK9bbf28e791f4f6450bc4b7992efe0f73afec4845)
-![](http://data.eolinker.com/course/AaFng1U9eff6d6d2e3fb483a44283a8ee5b6a0b756c978b)
 # 企业支持
 Goku API Gateway EE（企业版本）拥有更强大的功能、插件库以及专业的技术支持服务，如您需要了解可以通过以下方式联系我们。
@@ -259,4 +222,4 @@ You may obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and limitations under the License.
 ```
\ No newline at end of file