kong/kced

kced

镜像概述

kced是Kong APIOps功能的临时命令行界面（CLI）工具，基于Kong的go-apiops库构建。它提供了一套改进的APIOps工具集，专门用于简化Kong Gateway部署的操作流程，支持配置文件管理、API规范转换等核心APIOps任务。

核心功能与特性

• 合并decK文件：支持将多个decK格式的配置文件合并为单个文件
• OpenAPI转换：将OpenAPI规范文件转换为Kong的decK格式配置
• 应用补丁：在现有decK文件基础上应用补丁进行配置更新
• 版本信息：查看当前kced工具的版本号
• 命令帮助：提供详细的命令使用说明和帮助文档

使用场景

• Kong Gateway部署的配置文件管理与合并
• 将OpenAPI规范转换为Kong兼容的decK配置格式
• 对Kong配置文件进行补丁更新和版本控制
• 自动化Kong Gateway的APIOps工作流

使用方法

拉取镜像

使用以下命令拉取指定版本的kced镜像：

bash
docker pull kong/kced:<tag>

基本使用

运行容器即可查看kced的基本使用说明：

bash
docker run kong/kced:v0.1.11

执行后将显示工具概述及可用命令列表：

A temporary CLI that drives the Kong go-apiops library.

go-apiops houses an improved APIOps toolset for operating Kong Gateway deployments.

Usage:
  kced [command]

Available Commands:
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  merge        Merges multiple decK files into one
  openapi2kong Convert OpenAPI files to Kong's decK format
  patch        Applies patches on top of a decK file
  version      Print the kceD version

Flags:
  -h, --help   help for kced

Use "kced [command] --help" for more information about a command.

常用命令示例

查看版本信息

bash
docker run kong/kced:v0.1.11 version

合并decK文件

bash
docker run -v $(pwd):/workspace kong/kced:v0.1.11 merge -i file1.yaml file2.yaml -o merged.yaml

转换OpenAPI到decK格式

bash
docker run -v $(pwd):/workspace kong/kced:v0.1.11 openapi2kong -i openapi.yaml -o deck.yaml

应用补丁

bash
docker run -v $(pwd):/workspace kong/kced:v0.1.11 patch -i base.deck.yaml -p patch.yaml -o patched.deck.yaml

命令参数

• -h, --help: 显示命令帮助信息
• 各子命令的详细参数可通过 kced [command] --help 查看

完整文档

完整的使用文档和详细说明请参考GitHub仓库：
https://github.com/Kong/go-apiops/tree/main/docs