AI 助理
备案控制台
开发者社区 Java技术进阶 文章 正文

SIA-GateWay之API网关安装部署指南

2019-09-11 4819
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
云原生 API 网关，700元额度，多规格可选
简介： SIA-GATEWAY是基于SpringCloud微服务生态体系下开发的一个分布式微服务网关系统。具备简单易用、可视化、高可扩展、高可用性等特征，提供云原生、完整及成熟的接入服务解决方案。本文介绍API网关的安装部署。

SIA-GATEWAY是基于SpringCloud微服务生态体系下开发的一个分布式微服务网关系统。具备简单易用、可视化、高可扩展、高可用性等特征，提供云原生、完整及成熟的接入服务解决方案。本文介绍API网关的安装部署。

一、环境

1.1 编译环境

  • Maven3+
  • nodejs

  • Jdk1.8+

1.2 运行时第三方依赖

  • Mysql5.6+
  • elasticsearch 5.5.2
  • kibana-5.5.2
  • kafka 2.12-2.0.0
  • redis 3.2.11
  • eureka-server

1.3 运行环境

  • 64bit OS，Linux/Mac/Windows/docker
  • JDK1.8+

二、源码下载

git clone https://github.com/siaorg/sia-gateway.git

2.1 源码结构如下：

.
├── sia-gateway-admin-buildcomponent  网关admin组件集合
│   ├── sia-gateway-admin             网关admin监控系统组件
│   ├── sia-gateway-synchspeed        网关对下游服务实时感知组件
│   ├── sia-gateway-stream            网关日志组件
│   ├── sia-gateway-service           网关系统辅助组件
│   ├── sia-gateway-monitor           网关监控、日志组件
│   │    ├── sia-gateway-reactive    
│   │    ├── sia-gateway-messaging    基础依赖 
│   │    ├── sia-gateway-sink
│   │    ├── sia-gateway-esclient
│   │    ├── sia-gateway-base
├── sia-gateway-admin-display         网关系统前端代码
├── sia-gateway-buildcomponent        网关core-buildcomponent
│   ├── sia-gateway-core              网关Core节点
│   │   ├── sia-gateway-base
│   │   ├── sia-gateway-messaging     基础依赖
│   │   ├── sia-gateway-reactive
│   │   ├── sia-gateway-template

三、初始化“API网关数据库”

1）MySQL的安装和配置详见MySQL官方文档

2）请下载项目源码并解压，获取 "API网关数据库初始化SQL脚本" 并执行即可。

"API网关数据库初始化SQL脚本" 位置为:

/sia-gateway/sia-gateway-admin/src/main/resources/db/gateway_admin.sql

四、配置“网关系统”

4.1 网关配置文件地址

# 网关admin中心conf
/sia-gateway/sia-gateway-admin-buildcomponent/config/gateway_admin_test.yml

# 网关监控服务conf
/sia-gateway/sia-gateway-admin-buildcomponent/config/gateway_monitor_test.yml

# 网关辅助节点conf
/sia-gateway/sia-gateway-admin-buildcomponent/config/gateway_service_test.yml

# 网关日志服务conf
/sia-gateway/sia-gateway-admin-buildcomponent/config/gateway_stream_test.yml

# 网关实时感知服务conf
/sia-gateway/sia-gateway-admin-buildcomponent/config/gateway_synchspeed_test.yml

# 网关核心节点conf
/sia-gateway/sia-gateway-buildcomponent/config/gateway_test.yml

1）gateway_admin_test.yml

2）gateway_service_test.yml

3）gateway_stream_test.yml

4）gateway_synchspeed_test.yml

5）gateway_monitor_test.yml

6）gateway_test.yml

说明：spring.application.name为网关组名称，开发者可以修改此属性，搭建新的网关组

4.2 maven 仓库地址配置

  <mirrors>
       <mirror>
              <id>alimaven</id>
              <name>aliyun maven</name>
              <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
              <mirrorOf>central</mirrorOf>        
      </mirror>
  </mirrors>
  <profiles>
        <profile>
            <id>jdk-1.8</id>
            <activation>
                <activeByDefault>true</activeByDefault>
                <jdk>1.8</jdk>
            </activation>
            <properties>
                <maven.compiler.source>1.8</maven.compiler.source>
                <maven.compiler.target>1.8</maven.compiler.target>
                <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
            </properties>
        </profile>

        <profile>
            <id>downloadSources</id>
            <properties>
                <downloadSources>true</downloadSources>
                <downloadJavadocs>true</downloadJavadocs>
            </properties>
        </profile>
        <profile>  
            <id>spring plugins</id>  
            <activation>  
              <jdk>spring plugins</jdk>  
            </activation>  
            <pluginRepositories>  
              <pluginRepository>  
                <id>spring plugins</id>  
                <name>Spring plugins</name>  
                <url>https://maven.aliyun.com/repository/spring-plugin</url>  
                <layout>default</layout>  
                <snapshotPolicy>always</snapshotPolicy>  
              </pluginRepository>  
            </pluginRepositories>  
        </profile>  
    </profiles>

    <activeProfiles>
        <activeProfile>downloadSources</activeProfile>
    </activeProfiles>

五、构建部署项目

5.1 编译项目

1）如果已经正确进行上述配置，可将项目编译打包部署。

2）操作步骤：

    cd sia-gateway
    
    chmod +x *.sh
    
    sh build.sh

3）打包成功后，会出现以下标注文件。

  • /sia-gateway/sia-gateway-admin-buildcomponent/target/gateway_admin_1.0.zip

  • /sia-gateway/sia-gateway-buildcomponent/target/gateway_1.0.zip

  • /sia-gateway/sia-gateway-admin-display/dist/

注：前端打包需要用到nodeJs,如未安装，可请参考 nodejs安装文档。

5.2 部署项目

  • API网关系统的部署方式为分布式部署集中式管理模式，即网关Core节点可以按业务线划分为不同的网关组，网关管理端作为网关的管理中心，供统一的管理界面，用户可在此进行 API、组件、系统基础信息的设置和维护，收集监控日志、生成各种运维管理报表、自动告警等。
  • sia-gateway-admin-buildcomponent是网关管理端组件集，包括：admin、stream、service、synchspeed、monitor；管理端部署单个节点即可（目前不支持集群）。

  • sia-gateway-buildcomponent为网关Core组件，可以按业务线分组，组内以单节点或集群方式部署。

5.3 Vmware方式部署

1）后端部署

unzip gateway_admin_1.0.zip

cd /gatewayadmin/bin

chmod +x *.sh 

#启动网关管理服务，包括：admin、stream、service、synchspeed、monitor。
sh onekey_start.sh

---------------------------------------------------
unzip gateway_1.0.zip

cd /gateway/bin

chmod +x *.sh 

#启动网关Core服务
sh start_gateway_test.sh

2）前端部署

  • 修改前端site-map.js

  • nginx的代理配置，进入nginx的目录下nginx.conf，添加如下配置：

    upstream apigateway.open.location1 { 
   #### sia-gateway-admin服务IP
  server *******:8090 ; 
}
server {
 # nginx 监听端口
listen       18086;
server_name  localhost;
access_log  logs/host.access.log  main;
#access_log  "pipe:rollback logs/host.access_log interval=1d baknum=7 maxsize=2G"  main;
location / {
    #root   html;
    #index  index.html index.htm;
    root  /app/jar/ROOT/dist;
    index  index.html index.htm;
}
# 后端服务location 
location ^~ /vv1/  {
        proxy_pass http://apigateway.open.location1/;  
        proxy_set_header   Host  $host; 
        proxy_set_header   X-Real-IP $http_x_forwarded_for; 
        proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for; 
        proxy_http_version 1.1;
}
error_page   500 502 503 504  /50xcn.html;
location = /50xcn.html {
    root   html/error_page;
    index 50xcn.html;
}
location /check_status {
    vhost_traffic_status_display;
    vhost_traffic_status_display_format json;
}
}

  • 重启nginx

    #校验配置是否正确
./nginx -t

# 重新启动
./nginx -s reload

5.4 Docker 镜像方式部署

说明：如果docker环境和编译环境是在同一个操作系统上，可直接执行以下步骤；反之，需要先将以下文件按原目录结构上传docker环境所在服务器。

  • /sia-gateway/sia-gateway-admin-buildcomponent/target/gateway_admin_1.0.zip
  • /sia-gateway/sia-gateway-buildcomponent/target/gateway_1.0.zip
  • /sia-gateway/sia-gateway-admin-display/dist/
  • /sia-gateway/third-libary
  • /sia-gateway/build.sh
  • /sia-gateway/docker-start.sh
  • /sia-gateway/docker-run.sh
  • /sia-gateway/Dockerfile

步骤：

1）配置：修改site-map.js，位置：/dist/static/site-map.js

        /**
         * vmware部署： 127.0.0.1 ----> nginx的ip地址
         * docker镜像部署： 127.0.0.1 ----> docker容器的宿主机ip
         */
        'CESHI_API_HOST': '127.0.0.1:18086/vv1',
        
        /**
         * 127.0.0.1 ----> kibana的ip地址
         */
        'CESHI_API_HOST_LOG': '127.0.0.1:5601'

2）下载centos基础镜像，如果已经下载，此步忽略。

3）修改Dockerfile,FROM 镜像名 : 版本号

4）配置yum源，如果部署机器能够使用阿里yum源，此步忽略。

将yum源文件名称修改成 CentOS-Base.repo，并替换到/sia-gateway/third-libary/下

5）构建镜像，并启动容器和服务

    # 构建镜像
    cd /sia-gateway/ 
    
    # 授权
    chmod +x *.sh
    
    # 构建镜像
    sh docker-build.sh
    
    # 启动容器和服务
    sh docker-run.sh
    
    # 查看容器是否启动成功
    docker ps 
    
    # 进入容器查看服务运行情况
    docker exec -it gateway-test:v1 bash

访问地址： http://宿主机IP:18086/

说明：

来源：宜信技术学院

文章标签：
API 网关
日志服务
容器
Docker
API
Shell
应用服务中间件
nginx
关键词：
Gateway网关
API安装
Gateway api
网关安装
Gateway api网关
宜信技术学院
目录
相关文章
gkkkkk
|
1月前
|
负载均衡 Java 应用服务中间件
Gateway服务网关
Gateway服务网关
gkkkkk
53 1
Gateway服务网关
蓝易云
|
24天前
|
负载均衡 Java API
项目中用的网关Gateway及SpringCloud
Spring Cloud Gateway 是一个功能强大、灵活易用的API网关解决方案。通过配置路由、过滤器、熔断器和限流等功能，可以有效地管理和保护微服务。本文详细介绍了Spring Cloud Gateway的基本概念、配置方法和实际应用，希望能帮助开发者更好地理解和使用这一工具。通过合理使用Spring Cloud Gateway，可以显著提升微服务架构的健壮性和可维护性。
蓝易云
32 0
小王老师呀
|
5月前
|
Prometheus Kubernetes Cloud Native
云原生周刊：Argo Rollouts 支持 Kubernetes Gateway API 1.0 ｜ 2024.7.1
探索开源世界：Kubetools的推荐系统[Krs](https://github.com/kubetoolsca/krs)助力K8s优化，追踪K8s组件清单，指引IAC集成。阅读建议： Prometheus与Thanos的进化故事，Adidas容器平台管理经验，K8s请求实现详解。关注云原生：Argo Rollouts支持Gateway API 1.0，Kubewarden v1.14强化策略与镜像安全。
小王老师呀
66 0
土木林森
|
3月前
|
负载均衡 Java 网络架构
实现微服务网关：Zuul与Spring Cloud Gateway的比较分析
实现微服务网关：Zuul与Spring Cloud Gateway的比较分析
土木林森
163 5
热爱技术的小郑
|
4月前
|
Java API 微服务
服务网关Gateway
该博客文章详细介绍了Spring Cloud Gateway的使用方法和概念。文章首先阐述了API网关在微服务架构中的重要性，解释了客户端直接与微服务通信可能带来的问题。接着，文章通过具体的示例代码，展示了如何在Spring Cloud Gateway中添加依赖、编写路由规则，并对路由规则中的基本概念如Route、Predicate和Filter进行了详细解释。最后，文章还提供了路由规则的测试方法。
热爱技术的小郑
63 0
服务网关Gateway
路边两盏灯
|
4月前
|
安全 API
【Azure API 管理】APIM Self-Host Gateway 自建本地环境中的网关数量超过10个且它们的出口IP为同一个时出现的429错误
【Azure API 管理】APIM Self-Host Gateway 自建本地环境中的网关数量超过10个且它们的出口IP为同一个时出现的429错误
路边两盏灯
63 0
路边两盏灯
|
4月前
|
存储 容器
【Azure 事件中心】为应用程序网关(Application Gateway with WAF) 配置诊断日志，发送到事件中心
【Azure 事件中心】为应用程序网关(Application Gateway with WAF) 配置诊断日志，发送到事件中心
路边两盏灯
86 0
互联网课堂
|
5月前
|
JSON 前端开发 Java
SpringCloud怎么搭建GateWay网关&统一登录模块
本文来分享一下，最近我在自己的项目中实现的认证服务，目前比较简单，就是可以提供一个公共的服务，专门来处理登录请求，然后我还在API网关处实现了登录拦截的效果，因为在一个博客系统中，有一些地址是可以不登录的，比方说首页；也有一些是必须登录的，比如发布文章、评论等。所以，在网关处可以支持自定义一些不需要登录的地址，一些需要登录的地址，也可以在网关处进行校验，如果未登录，可以返回JSON格式的出参，前端可以进行相关处理，比如跳转到登录页面等。
互联网课堂
148 4
左诗右码
|
5月前
|
应用服务中间件 API 数据库
Docker 安装 KONG 带你玩转 API 网关
**摘要：** 在微服务架构中，API网关Kong作为流行开源选择，提供身份验证、安全和流量控制等功能。通过Docker部署Kong简单高效。步骤包括：创建Docker网络，部署PostgreSQL数据库，初始化Kong数据库，启动Kong容器，并检查运行状态。此外，安装Konga管理界面便于直观管理Kong。使用Docker命令行，逐步设置环境变量和网络连接，即可完成安装。当不再需要时，可清理相关容器和网络。Kong结合Konga，为API管理提供强大且用户友好的解决方案。
左诗右码
321 1
理想shi做条咸鱼
|
4月前
|
负载均衡 Java 应用服务中间件
Gateway服务网关
本节针对微服务中另一重要组件：网关 进行了实战性演练，网关作为分布式架构中的重要中间件，不仅承担着路由分发（重点关注Path规则配置），同时可根据自身负载均衡策略，对多个注册服务实例进行均衡调用。本节我们借助GateWay实现的网关只是技术实现的方案之一，后续大家可能会接触像：Zuul、Kong等，其实现细节或有差异，但整体目标是一致的。
理想shi做条咸鱼
173 0