Skip to main content
版本: 0.4.3

配置

使用 KCL 编写配置代码

KCL 的核心特性是其建模约束能力,KCL 核心功能基本围绕 KCL 这个两个核心特性展开,此外 KCL 遵循以用户为中心的配置理念而设计其核心特性,可以从两个方面理解:

  • 以领域模型为中心的配置视图:借助 KCL 语言丰富的特性及 KCL OpenAPI 等工具,可以将社区中广泛的、设计良好的模型直接集成到 KCL 中(比如 K8s 资源模型),用户也可以根据自己的业务场景设计、实现自己的 KCL 模型 (库) ,形成一整套领域模型架构交由其他配置终端用户使用。
  • 以终端用户为中心的配置视图:借助 KCL 的代码封装、抽象和复用能力,可以对模型架构进行进一步抽象和简化(比如将 K8s 资源模型抽象为以应用为核心的 Server 模型),做到最小化终端用户配置输入,简化用户的配置界面,方便手动或者使用自动化 API 对其进行修改。

不论是以何为中心的配置视图,对于代码而言(包括配置代码)都存在对配置数据约束的需求,比如类型约束、配置字段必选/可选约束、范围约束、不可变性约束等,这也是 KCL 致力于解决的核心问题之一。

我们可以编写一个名为 main.k 的 KCL 配置文件

schema Person:
gender: "Male" | "Female"
name: Name

schema Name:
first: str
middle?: str # Optional, but must be non-empty when specified
last: str

check:
first != ""
last != ""
middle != ""

alice = Person {
# gendre: "Female" # Error: misspelled attribute
gender: "Female"
name.first: "Alice"
name.last: "White"
}

执行命令

kcl main.k

我们可以通过代码化的方式得到了一个 YAML 配置文件输出,这即是 KCL 的基本使用方式。

alice:
gender: Female
name:
first: Alice
last: White