README.md

简介

Kong Gateway (OSS) - 一个轻量级开源网关。

• 项目官方网站：https://konghq.com/
• 项目源码地址：https://github.com/Kong/kong

Kong是一个云原生，快速，可扩展和分布式微服务抽象层（也称为API网关，API中间件或某些情况下的Service Mesh）。作为2015年的开源项目，其核心价值在于高性能和可扩展性。

由于对项目的积极维护，Kong被广泛用于从初创公司到全球500强以及政府机构的生产中。

提示

重要❗️： 本文档是基于 版本，目前官网已经更新至 版本，如果使用的其他版本，请查看官方文档：

版本说明

• 官网最新版本：

• 官网维护版本：

• 历史存档版本：

本篇文档说明：https://102no.com/2019/06/27/kong-docs-cn/

安装文档目录

• 官方支持

  • 包安装
    • 使用 Docker 安装
    • 在 Ubuntu 上安装
    • 在 CentOS 上安装
    • 在 macOS 上安装
    • 在 Debian 上安装
    • 在 Red Hat 上安装
    • 在 Amazon Linux 上安装
  • 云安装
    • 在 Kubernetes 上安装 Kong 和 Kong Enterprise
    • 在 DC/OS 集群部署
    • 在 Google Cloud 上安装
    • 在 AWS 软件市场 AMI上安装
  • 源安装
    • 在 Vagrant 上安装
    • 使用源码安装

开发文档目录

• 快速入门
  • 简介
  • 五分钟快速开始
  • 配置一个服务
  • 启用插件
  • 添加消费者
• 开发指南
  • 配置
  • CLI
  • 代理
  • 认证
  • 负载均衡
  • 健康检查和断路器
  • 集群
  • 日志
  • 网络&防火墙
  • 保证 Admin API 安全
  • 插件开发
    • 简介
    • 文件结构
    • 实现自定义逻辑
    • 插件配置
    • 访问数据存储区
    • 存储自定义实体
    • 缓存自定义实体
    • 扩展Admin API
    • 编写单元测试
    • 安装/卸载插件
  • 插件开发套件(PDK)
    • kong.client
    • kong.ctx
    • kong.ip
    • kong.log
    • kong.node
    • kong.request
    • kong.response
    • kong.router
    • kong.service
    • kong.service.request
    • kong.service.response
    • kong.table
• Admin Api
  • 无数据库模式 Admin API
  • 支持的 Content Types
  • 信息路由
  • 标签
  • Service 对象
  • Route 对象
  • Consumer 对象
  • 插件对象
  • 证书对象
  • SNI 对象
  • Upstream 对象
  • Target 对象

插件文档目录

• 认证

  • Basic Authentication 基础认证插件
  • HMAC Authentication 认证插件
  • JWT 插件
  • Key Authentication 密钥认证插件
  • LDAP Authentication 认证插件
  • OAuth 2.0 Authentication 认证插件
  • Session 插件

• 安全

  • CORS 插件
  • IP Restriction 插件
  • Bot Detection 机器人检测插件

• 日志

  • File Log 插件
  • TCP Log 插件
  • UDP Log 插件
  • HTTP Log 插件
  • Loggly 插件
  • StatsD 插件
  • Syslog 插件

• 变更

  • Correlation ID 关联 ID插件
  • Request Transformer 请求变更插件
  • Response Transformer 响应变更插件

• 传输限制

  • ACL 插件
  • Proxy Caching 代理缓存插件
  • Rate Limiting 速率限制插件
  • Response Rate Limiting 响应率限制插件
  • Request Termination 请求终止插件
  • Request Size Limiting 请求大小限制插件

• 无服务

  • AWS Lambda 插件
  • Serverless Functions 插件
  • Apache OpenWhisk 插件

• 分析与监测

  • Datadog 插件
  • Zipkin 插件
  • Prometheus 插件

• 部署

  • Kubernetes Sidecar 注入插件
  • decK 插件

官方博客

• Kong 1.0 GA 版本正式发布(更新详情)
• Kong 1.0.0 升级指南
• Kong 1.3 发布！支持原生gRPC代理，上游双向TLS认证，以及更多功能
• Kong 1.4 发布！自动检测Cassandra Topology 更改，自定义Host Header以及更多功能！
• Kong 2.0 正式发布！
• Kong 2.0 升级指南！
• Kong 2.1 正式发布！
• Kong 2.2 正式发布！
• Kong 2.3 正式发布！
• Kong 2.4 正式发布！
• Kong 2.5 正式发布了！
• Kong 2.6 正式发布啦！
• Kong 2.7 已经准备就绪！
• Kong 2.8 已经发布：提高安全性，简化API管理
• Kong Gateway 3.0正式发布！
• Kong Gateway 3.6.x 正式发布，较大改变！
• Kong 3.7重磅上线！Kong AI Gateway 正式 GA！
• Kong Gateway 3.8 正式 GA！

译者注： 翻译这个文档的原因是自己正好在学习这个kong，一方面也是锻炼自己的英语能力，所以采用的是人工+机翻结合的方式，如果有遇到翻译的不够通顺，或者对于翻译的语句有歧义的地方，麻烦一定点击官网英文文档 https://docs.konghq.com/gateway-oss/ 查看，并且欢迎提 PR 提修改意见。另，由于kong的文档本身也在不断增加和完善当中，如果有遇到没有即使更新翻译的状况欢迎提issue，我会不断补充的。

todo：

• 目前文档中的超链接都是链接的英文原文，后续会慢慢改成中文内链。
• 会在每一页文档里面附上单独的英文原文链接，以便做对照。
• 会添加kong自带的插件文档。