Skip to main content
版本: 0.9

自动化

简介​

在 KCL 中提供了很多自动化相关的能力，主要包括工具和多语言 API。 通过 package_identifier : key_identifier的模式支持对任意配置键值的索引，从而完成对任意键值的增删改查。比如下图所示修改某个应用配置的镜像内容，可以直接执行如下指令修改镜像，修改前后的 diff 如下图所示。

此外，KCL 的自动化能力也可以被集成到 CI/CD 中。

使用 KCL 进行自动化​

0. 先决条件​

1. 获得示例​

git clone https://github.com/kcl-lang/kcl-lang.io.git/
cd ./kcl-lang.io/examples/automation

我们可以执行如下命令显示配置

cat main.k

输出为

schema App:
    """The application model."""
    name: str
    replicas: int
    labels?: {str:str} = {app = name}

app: App {
    name = "app"
    replicas = 1
    labels.key = "value"
}

我们可以执行如下命令输出配置

kcl main.k

输出为

app:
  name: app
  replicas: 1
  labels:
    app: app
    key: value

2. 使用 KCL CLI 进行自动化​

KCL 允许使用通过 CLI -O|--overrides 参数修改配置模型中的值，这个参数通常由三个部分组成: 包名 pkg, 配置标识符 identifier, 配置属性 attribute 和覆盖值 override_value

kcl main.k -O override_spec
  • override_spec: 表示需要修改的配置模型字段和值的统一表示
override_spec: identifier (("=" | ":" | "+=") value | "-")
  • identifier: 表示需要修改配置的标识符，通常为 a.b.c 或者 a["dot.key"].c 的形式
  • value: 表示需要修改配置的值，可以是任意合法的 KCL 表达式，比如数字/字符串字面值，list/dict/schema 表达式等
  • =, - 和 +=: 表示用对应的属性运算符修改 identifier 的值
    • 当 identifier 存在时，修改已有 identifier的值为 value
    • 当 identifier 不存在时，添加 identifier属性，并将其值设置为 value
  • -: 表示删除 identifier属性
    • 当 identifier 存在时，直接进行删除
    • 当 identifier 不存在时，对配置不作任何修改

请注意，当 identifier 出现多次时，修改/删除全部 identifier 的值

修改配置​

执行如下命令可以更新应用名称:

kcl main.k -O app.name=\'new_app\'

输出为

app:
  name: new_app
  replicas: 1
  labels:
    app: new_app
    key: value

可以看出 app 的 name 属性的值被修改为了 new_app

此外，当我们使用 KCL CLI -d 参数时，KCL 文件将同时修改为以下内容

kcl main.k -O app.name=\'new_app\' -d
schema App:
    """The application model."""
    name: str
    replicas: int
    labels?: {str:str} = {app = name}

app: App {
    name = "new_app"
    replicas = 1
    labels: {key = "value"}
}

注意当配置块中 app 的 name 属性不存在时, 它会被新增到配置块中。

删除配置​

执行如下命令可以删除 labels 中的 key 字段

kcl main.k -O app.labels.key-

输出为:

app:
  name: app
  replicas: 1
  labels:
    app: app

3. 使用 KCL API 进行自动化​

此外，我们还可以通过多语言 API 自动修改配置属性

以 RestAPI 为例

执行如下命令启动 RestAPI 服务端

kcl server

通过如下命令 POST 命令请求配置修改服务

curl -X POST http://127.0.0.1:2021/api:protorpc/KclvmService.OverrideFile -H 'content-type: accept/json' -d '{
    "file": "main.k",
    "specs": ["app.name=\"nginx\""]
}'

服务调用完成后，main.k 会被修改为如下形式:

schema App:
    """The application model."""
    name: str
    replicas: int
    labels?: {str:str} = {app = name}

app: App {
    name = "nginx"
    replicas = 1
    labels: {
        "key" = "value"
    }
}

小结​

该文档介绍了KCL的自动化功能，包括工具和多语言 API。它支持对任何配置的键值进行索引，允许添加、删除、修改和查询任何键值。它也可以集成到 CI/CD 中。本文档提供了一个使用 KCL 自动化配置管理的示例，包括使用 KCL CLI/API 覆盖和删除配置。更多信息请参阅此处。