网关服务Kong、Konga搭建记录

标签：网关 compose 服务 Konga database Kong kong KONG

安装

使用docker-compose安装是最方便的
在/opt/目录下创建kong文件夹，然后创建一个docker-compose.yml文件并编辑

cd /opt
mkdir kong
cd kong
vi docker-compose.yml

在docker-compose.yml添加如下配置（20220528亲测可用）

version: '3'
services: 
  kong-database:
    image: postgres:9.6
    restart: always  #每次总是启动
    networks: 
      - kong-net
    environment:
      POSTGRES_USER: kong
      POSTGRES_DB: kong
      POSTGRES_PASSWORD: kong
    ports:
      - "5432:5432"
#######################
# 执行数据库迁移
######################
  kong-migration:
    image: kong:latest
    command: "kong migrations bootstrap"
    networks: 
      - kong-net
    restart: on-failure
    environment:
      - KONG_DATABASE=postgres
      - KONG_PG_DATABASE=kong
      - KONG_PG_PASSWORD=kong
      - KONG_PG_HOST=kong-database
    links: 
      - kong-database #连接的是kong-database服务的
    depends_on:
      - kong-database #依赖于kong-database服务
#####################
# kong gateway
#####################
  kong:
    image: kong:latest
    restart: always
    networks:
      - kong-net
    environment:
      KONG_DATABASE: postgres
      KONG_PG_HOST: kong-database
      KONG_PG_PASSWORD: kong
      KONG_PROXY_LISTEN: 0.0.0.0:8000          # 代理监听http
      KONG_PROXY_LISTEN_SSL: 0.0.0.0:8443       # 代理监听https
      KONG_ADMIN_LISTEN: 0.0.0.0:8001     # Kong的管理API，不可暴露在公网
    depends_on:
      - kong-migration
    links: 
      - kong-database
    healthcheck:
      test: ["CMD", "curl", "-f", "http://kong:8001"]
      interval: 5s
      timeout: 2s
      retries: 15
    ports:
      - "8001:8001"
      - "8000:8000"
      - "8443:8443"
#######################
#以下两个是konga  GUI
#######################
  konga-prepare:
    image: pantsel/konga:latest
    command: "-c prepare -a postgres -u postgresql://kong:kong@kong-database:5432/konga"  #注意是用户名：密码@数据库服务名称：端口
    networks:
      - kong-net
    restart: on-failure
    links:
      - kong-database
    depends_on:
      - kong        #依赖kong服务
      - kong-database #依赖kong-database服务
  konga:
    image: pantsel/konga:latest
    restart: always
    networks:
      - kong-net
    environment:
      DB_ADAPTER: postgres
      DB_HOST: kong-database
      DB_USER: kong
      DB_DATABASE: konga
      DB_PASSWORD: kong #必须加上密码，不然会失败
    depends_on:
      - kong
      - kong-database
    ports:
      - "1337:1337" #控制台访问端口
networks:
  kong-net:
    driver: bridge

docker-compose.yml文件参考自
https://wenku.baidu.com/view/eda035c19889680203d8ce2f0066f5335a81670e.html

访问Konga控制台

假设使用的是本地搭建
使用浏览器访问127.0.0.1:1337
注：端口号在docker-compose.yml中指定了1337

若是使用云服务器，注意做好DNS解析以及Nginx配置
这里给出一份可用的kong.conf

server{
    listen 80;
    server_name  kong.YOUR_DOMAIN.com;
    charset utf-8;

    # 接口
    location / {
      proxy_pass http://127.0.0.1:1337;
      proxy_set_header X-Forwarded-Proto $scheme;
      proxy_set_header X-Forwarded-Port $server_port;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection "upgrade";
    }
}

使用浏览器访问kong.YOUR_DOMAIN:1337

首次进入配置管理员

打开界面后，是要创建一个管理员账号的，按说明填写即可

配置Kong管理API

先理解一下概念：
我们现在操作的可视化平台是Konga
Konga通过调用Kong的admin url，对Kong网关进行配置管理
所以这一步我们需要将Konga和Kong搭上线

在Connection页面配置要管理的Kong网关

主要填写参数说明：
Name：必填，唯一，用于备忘
Kong Admin URL：Kong网关的管理路径，默认端口是8001，在docker-compose.yml可修改对外暴露的端口号

这里有个提示很显眼：Kong's admin API should not be publicly exposed
故我们在云服务器部署时，都应该注意8001的这个端口不应随意暴露出去，以免发生黑客攻击风险

为什么配置出来是http://kong:8001？
因为本次使用的是docker-compose部署，Kong和Konga还有Postgres这几个容器都处于kong-net这个网络环境下，可以直接通过容器名访问到对方
Konga是在接收到浏览器请求后，通过后台服务调用Kong admin URL
如果用了其他方式部署，则需要按实际情况填写Kong admin URL，并且注意不要暴露到公网上！