阅读 228

KCL:声明式的云原生配置策略语言

楔子: 以蚂蚁典型的建站场景为例,在接入 Kusion 后,用户侧配置代码减少到 5.5%,用户面对的 4 个平台通过接入统一代码库而消减,在无其他异常的情况下交付时间从 2 天下降到 2 小时……

注:本文是柴树杉在 2021 GIAC 大会上分享的内容。相关 PPT 内容请点击下方自行下载

GIAC 大会 PPT 下载:KCL声明式的云原生配置策略语言

0. 你好GIAC

大家好,我是来自蚂蚁的同学,很高兴能在GIAC的编程语言新范式板块和大家分享《KCL配置策略语言》。KCL语言是蚂蚁内部的Kusion解决方案中针对云原生基础设施配置代码化自研的DSL语言,目前已经在建站场景等一些场景开始小范围推广试用。

我们先看一下简单的KCL代码:

schema GIACInvitation[name: str]:
	Name:     str = name
	Topic:    str = "分享主题"
	Company?: str = None
	Type:     str = "分享嘉宾"
	Address:  str = "深圳"

invitation = GIACInvitation("姓名") {
	Topic:   "KCL配置策略语言"
	Company: "蚂蚁集团"
}
复制代码

这个例子代码先通过 schema 定义了一个 GIACInvitation 结构体:该结构体有一个 str 类型的 name 参数,同时还有一组标注了类型和默认值的属性。然后通过声明式的语法构造了GIACInvitation 的实例 invitation

这个例子虽然简单,但是包含了 KCL 最重要的 schema 语言结构。从例子可以看出 KCL 尝试通过声明式的语法、静态类型检查特性来改进配置代码的编写和维护工作。这也是设计 KCL 语言的初衷,我们希望通过编程领域成熟的技术理论来解决云原生领域的配置代码化的问题。

1. KCL语言的诞生背景

在经典的 Linux/UNIX 操作系统中,我们通过 Shell 和系统内置的各种工具和内核进行交互,同时通过 Shell 脚本来管理更上层的 App。可以说 Shell 语言极大地简化了内核的编程界面,不仅仅提升了操作系统易用性也简化了上层 App 的管理和运维,也提高了生产效率。而 Kubernetes 作为容器管理领域的事实标准,已经成为云计算时代的Linux/UNIX。类比 UNIX 系统,Kubernetes 目前还缺少一种符合其声明式、开放、共享设计理念的交互语言及工具。

1.1 为何要设计KCL语言?

K8s已经成为云计算的操作系统,但是目前尚缺少功能完备的SHELL交互界面。目前虽然有很多而且开源方案,但是还没有像UNIX的Shell那种出现比较成熟的方案,特别是尚无法满足头部互联网企业大规模工程化的要求。云原生技术与企业落地之间存在Gap需要填补,这正是云原生工程化要解决的问题,也是设计KCL语言的出发点。

1.2 目前是一个好时机

云原生的思路是高度的开放化和民主化,结果就是万物可配置,一切配置都是代码。带配置代码面前人人平等,每个用户都可以通过调整配置代码和基础平台设施进行交互。因此对配置的编写和维护正在成为云计算时代软件工程师的必备的技能和需求。基于对云原生配置代码化需求的日益旺盛,硅谷的诸多头部公司已经对这个方向进行了大规模的实践和验证,这些都给了我们大量可以参考的经验。

因此蚂蚁的 Kusion 项目尝试通过 KCL 配置策略语言正是为了简化云原生技术设施的接入方式设计,其设计目标不仅仅是为了提升蚂蚁基础设施的开放程度及使用效率,同时希望能够优化共享、协同的开发流程,可以说其定位正是云原生时代的 Shell 语言。虽然目前还处于探索和实践阶段,我们通过此文和大家分享下 KCL 语言的设计与实现的一些理念,为云原生的快速到来贡献一点绵薄之力。

1.3 KCL诞生历史

KCL 语言从2019年开始初期的调研和设计工作。到2020年3月发布kcl-0.1,基于Python定制语法,采用Go版本的Grumpy和AntLR等工具开发。2020年下半年改用Python语言并加快了开发和迭代速度,发布的kcl-0.2.x引入了大量语言特性、增加了Plugin扩展支持、同时支持IDEA插件。2021年上半年开始统一优化和整合语言特性,发布的kcl-0.3优化类型系统、集成单元测试工具、优化执行性能并提供了Go等多语言的API支持、同时通过LSP为VSCode提供支持。2021年下半年开始在建站等常见落地,同时引入静态类型检查和优化性能,完善语言的文档支持。

2. KCL语言的设计原则

基于蚂蚁践行多年的经典运维中台沉淀的经验和对各种问题利弊的思考,Kusion 项目对如何充分利用云原生技术带来的红利,打造一个开放、透明、声明式、可协同的运维体系进行了探索和思考,提出并实践了基于基础设施代码化的云原生协同开发的模型。而 KCL 语言正是 Kusion 项目为了解决云原生协同开发而设计的声明式的配置编程语言,简单、稳定、高效和工程化是 KCL 语言设计的设计理念。

2.1 简单为王

简单不仅仅可以降低学习和沟通的成本,而且可以减少代码出问题的风险。不论是 UNIX 奉行的 KISS 原则还是 Go语言推崇的 Less is more 设计理念,简化易用的界面始终是各种成功产品追求的一个目标。同样从简单原则出发,KCL 语言在参考现代编程语言之上只保留了必要的元素,同时通过类型自动推导、引入受限的控制流和 schema 提供了基础灵活的配置定义编写能力,删减语言特性始终是 KCL 语言设计工作的一个重要目标。

2.1.1 声明式语法

声明式编程是和命令式编程并列的一种编程范式,声明式编程只告诉你想要的结果,执行引擎负责执行的过程。声明式编程使用更加简单,可以降低命令式拼装造成的复杂性和副作用,保持配置代码清晰可读,而复杂的执行逻辑已经由 Kubernetes 系统提供支持。KCL 语言通过简化对 schema 结构体实例化的语法结构对声明式语法提供支持,通过仅提供少量的语句来减少命令过程式编程带来的复杂性。 围绕 schema 和配置相关的语法,KCL 希望每种配置需求尽可能通过固定的写法完成,使得配置代码尽可能的统一化。

比如作为 KCL 声明式语法的核心结构 schema 可以采用声明式方式实例化:

schema Name:
    firstName: str
    lastName: str

schema Person:
    name: Name = {
        firstName: "John"
        lastName: "default"
    }

JohnDoe = Person {
    name.lastName: "Doe"
}
复制代码

首先通过schema定义了一个 Name 结构,结构包含2个字符串类型的必填属性。然后在 Person 中复用 Name 类型声明一个name属性,并且给name属性设置了默认值以简化用户使用。最终在定义 JohnDoe 配置定义的时候,只需填写 name.lastName 一个属性参数即可,其他部分属性均采用默认的参数。

对于一些标准的业务应用,通过将可复用的模型封装为 KCL schema,这样可以为前端用户提供最简单的配置界面。比如基于蚂蚁内部Konfig大库中 sofa.SofaAppConfiguration 只需添加少量的配置参数就可以定制一个 App

appConfiguration = sofa.SofaAppConfiguration {
    resource: resource.Resource {
        cpu: "4"
        memory: "8Gi"
        disk: "50Gi"
    }
    overQuota: True
}
复制代码

通过声明式语法描述必要的参数(其他的参数全部采用默认配置),可以极大简化普通用户的配置代码。

2.1.2 顺序无关语法

有别于命令式编程,KCL 推崇的是更适合于配置定义的声明式语法。以斐波那契数列为例,可以把一组声明式的定义看作一个方程组,方程式的编写顺序本质上不影响方程组的求解,而计算属性依赖并“求解”的过程由 KCL 解释器完成,这样可以避免大量命令式拼装过程及顺序判断代码。

schema Fib:
    n1: int = n - 1
    n2: int = n1 - 1
    n: int
    value: int

    if n <= 1:
        value = 1
    elif n == 2:
        value = 1
    else:
        value = (Fib {n: n1}).value + (Fib {n: n2}).value

fib8 = (Fib {n: 8}).value  # 21
复制代码

代码中 Fib 定义的成员n、n1和n2有一定的依赖关系,但是和它们书写的顺序并无关系。KCL 语言引擎会根据声明式代码中的依赖关系自动计算出正确的执行顺序,同时对类似循环引用等异常状态告警。

2.2.3 同名配置合并

当整个业务和开发维护团队都变得复杂时,配置代码的编写和维护也将变得复杂化:同一份配置参数可能散落在多个团队的多个模块中,同时一个完整的应用配置则需要合并这些散落在不同地方的相同和不同配置参数才可以生效,而相同的配置参数可能因为不同团队的修改而产生冲突。通过人工方式同步这些同名配置和合并不同的配置都是一个极大的挑战。

比如 Konfig 大库中应用配置模型分为 base 和各环境 stack 配置,要求程序运行时按照某一 merge 策略合并为一份应用配置,相当于要求大库前端配置能够自动合并,即能够分开多次定义并且合并,然后实例化生成相应的唯一前端配置。借助 KCL 语言的能力和 Konfig 的最佳实践,可通过将基线配置和环境配置自动合并简化配置的编写。比如对于标准 SOFA 应用 opsfree,其基线配置和环境配置分别维护,最终交由平台工具进行配置合并和检查。KCL 语言通过自动化合并同名配置实现简化团队协同开发的设计目标。

比如 base 配置收集的通用的配置:

appConfiguration = sofa.SofaAppConfiguration {
    mainContainer: container.Main {
        readinessProbe: probe_tpl.defaultSofaReadinessProbe
    }
    resource: res_tpl.medium
    releaseStrategy: "percent"
}
复制代码

然后再预发环境在 base 配置的基础之上针对某些参数进行微调:

appConfiguration = sofa.SofaAppConfiguration {
    resource: resource.Resource {
        cpu: "4"
        memory: "8Gi"
        disk: "50Gi"
    }
    overQuota: True
}
复制代码

合并的 pre 配置实际是一份 SofaAppConfiguration 配置(相当于如下等效代码,环境配置的优先级默认高于基线配置)

appConfiguration = sofa.SofaAppConfiguration {
    mainContainer: container.Main {
        readinessProbe: probe_tpl.defaultSofaReadinessProbe
    }
    resource: resource.Resource {
        cpu: "4"
        memory: "8Gi"
        disk: "50Gi"
    }
    overQuota: True
    releaseStrategy: "percent"
}
复制代码

目前的同名配置虽然只针对应用的主包配置有效,但已经带来了可观察的收益。

2.2 稳定压倒一切

越是基础的组件对稳定性要求越高,复用次数越多的稳定性带来的收益也更好。因为稳定性是基础设施领域一个必备的要求,不仅仅要求逻辑正确,而且需要降低错误出现的几率。

2.2.1 静态类型和强不可变性

很多配置语言采用运行时动态检查类型。动态类型最大的缺点只能检查正在被执行属性的类型,这非常不利于开发阶段提前发现类型的错误。静态类型不仅仅可以提前分析大部分的类型错误,还可以降低后端运行时的动态类型检查的性能损耗。

除了静态类型,KCL 还通过 final 关键字禁止某些重要属性被修改。静态类型再结合属性的强不可变性,可以为配置代码提供更强的稳定性保障。 比如对于 CafeDeployment 中的 apiVersion 信息是一种常量类型的配置参数,final 为这类配置提供保障:

schema CafeDeployment:
    final apiVersion: str = "apps.cafe.cloud.alipay.com/v1alpha1"
    final kind: str = 123  # 类型错误

schema ContainerPort:
    containerPort: int = 8080
    protocol: "TCP" | "UDP" | "SCTP" = "TCP"
    ext? : str = None
复制代码

代码中 apiVersion 和 kind 属性都被 final 保护禁止被修改。但是 kind 因为属性类型初始值不同而隐含一个错误,通过静态类型检查很容易在开发阶段发现错误并改正。

2.2.2 运行时类型和逻辑check验证

KCL 的 schema 不仅仅是带类型的结构体,也可以用于在运行时校验存量的无类型的 JSON 和 YAML 数据。此外 schema 的 check 块可以编写语义检查的代码,在运行时实例化 schema 时会自动进行校验。同时,基于 schema 的继承和 mixin 可以产生跟多关联的 check 规则。

比如以下的例子展示 check 的常见用法:

schema sample:
    foo: str
    bar: int
    fooList: [str]

    check:
        bar > 0 # minimum, also support the exclusive case
        bar < 100, "message" # maximum, also support the exclusive case
        len(fooList) > 0 # min length, also support exclusive case
        len(fooList) < 100 # max length, also support exclusive case
        regex.match(foo, "^The.*Foo$") # regex match
        isunique(fooList) # unique
        bar in [range(100)] # range
        bar in [2, 4, 6, 8] # enum
        multiplyof(bar, 2) # multipleOf
复制代码

check 中每个语句都是一个可以产生 bool 结果的表达式和可选的错误信息组成(每个普通的 bool 表达式其实是assert 语句的简化而来)。通过内置的语法和函数可以实现在运行时对属性值的逻辑验证。

2.2.3 内置测试支持

单元测试是提升代码质量的有效手段。KCL 基于已有的 schema 语法结构,配合一个内置 kcl-test 命令提供灵活的单元测试框架(结合 testing 包可指定面值类型的命令行参数)。

内置测试工具

schema TestPerson:
    a = Person{}
    assert a.name == 'kcl'

schema TestPerson_age:
    a = Person{}
    assert a.age == 1
复制代码

kcl-test 命令不仅仅执行单元测试,还会统计每个测试执行的时间,而且可以通过正则表达式参数选择执行指定的测试。此外通过 kcl-test ./... 可以递归执行子目录的单元测试,同时支持集成测试和Plugin测试。

2.3 高效是永恒的追求

KCL 代码不仅仅通过声明式的风格简化编程,同时通过模块支持、mixin 特性、内置的 lint 和 fmt 工具、以及 IDE 插件提供高效的开发体验。

2.3.1 schema 中好用的语法

schema 是 KCL 编写配置程序的核心语法结构,其中几乎每个特性均是针对具体的业务场景提效而设计。比如在定义和实例化深层次嵌套的配置参数时,均可以直接指定属性的路径定义和初始化。

schema A:
    a: b: c: int
    a: b: d: str = 'abc'

A {
    a.b.c: 5
}
复制代码

同时为了安全,对于每个属性默认都是非空的字段,在实例化时会自动进行检查。

schema 不仅仅是一个独立的带类型注解的配置对象,我们也可以通过继承的方式来扩展已有的 schema:

schema Person:
    firstName: str
    lastName: str

# schema Scholar inherits schema Person
schema Scholar(Person):
    fullName: str = firstName + '_' + lastName
    subject: str

JohnDoe = Scholar {
    firstName: "John",
    lastName: "Doe",
    subject: "CS"
}
复制代码

代码中 Scholar 从 Person 继承,然后又扩展了一些属性。作为子类的 Scholar 可以直接访问父类中定义的firstName 等属性信息。

继承是 OOP 编程中基础的代码复用手段,但同时也有多继承导致的菱形继承的技术问题。KCL 语言刻意简化了继承的语法,只保留了单继承的语法。同时 schema 可以通过 mixin 特性混入复用相同的代码片段,对于不同的能力配套,我们通过 mixin 机制编写,并通过 mixin 声明的方式“混入”到不同的结构体中。

比如通过在 Person 中混入 FullnameMixin 可以给 schema 增加新的属性或逻辑(包括 check 代码块):

schema FullnameProtocol:
    firstName : str = "default"
    lastName : str

mixin FullnameMixin for FullnameProtocol:
    fullName : str = "${firstName} ${lastName}"

schema relax Person:
    mixin [FullnameMixin]
    firstName : str = "default"
    lastName : str
复制代码

通过 KCL 的语言能力,平台侧同学可以通过单继承的方式扩展结构体,通过 mixin 机制定义结构体内属性的依赖关系及值内容,通过结构体内顺序无关的编写方式完成声明式的结构体定义,此外还支持如逻辑判断、默认值等常用功能。

2.3.2 doc、fmt、lint和外围的LSP工具

在编程领域代码虽然是最核心的部分,但是代码对应的文档和配套的工具也是和编程效率高度相关的部分。策略设计哲学并不局限于语言本身,还包括文档、代码格式化工具、代码风格评估工具和IDE的支持等。KCL 通过 kcl-doc 支持从配置代码直接提取产生文档,自动化的文档不仅仅减少了手工维护的成本,也降低的学习和沟通成本。kcl-fmt 则很方便将当前目录下的全部代码(包含嵌套的子目录)格式化为唯一的一种风格,而相同格式的代码同样降低的沟通和代码评审的成本。kcl-lint 工具则是通过将一些内置的风险监测策略对 KCL 代码平行评估,方便用户根据评估结果优化代码的风格。

2.4 工程化的解决方案

任何语言想要在工程中实际应用,不仅仅需要很好的设计,还需要为升级、扩展和集成等常规的场景提供完整的解决方案。

2.4.1 多维度接口

KCL语言设计通过在不同的抽象层次为普通用户(KCL命令行)、KCL语言定制者(Go-API、Python-API)、KCL库扩展者(Plugin)和IDE开发者(LSP服务)均提供了几乎等价的功能界面,从而提供了最大的灵活度。

2.4.2 千人千面的配置DB

KCL 是面向配置的编程语言,而配置的核心是结构化的数据。因此,我们可以将完整 KCL 代码看做是一种配置数据库。通过 KCL 的配置参数的查询和更新(override/-O命令)可以和对应的配置属性路径,可以实现对属性参数的查询、临时修改和存盘修改。

将代码化的配置作为DB的唯一源,不仅仅可以集成DB领域成熟的查询和分析手段,而且可以通过配置代码视角调整配置代码的逻辑结构。特别是在自动化运维实践中,通过程序自动生成的配置代码修改的PullRequest可以方便引入开发人员进行代码评审,很好地达到人机通过不同界面配合运维。

2.4.3 版本平滑升级

随着业务和代码的演化,相关模块的 API 也会慢慢腐化。KCL 语言设计通过严格的依赖版本管理,然后结合语言内置的语法和检查工具保障 API 平滑的升级和过渡,再配合代码集成测试和评审流程提升代码安全。KCL 语言通过@deprecated特性在代码出现腐化早期给出提示,同时为用户的过渡升级留出一定的时间窗口,甚至等到API彻底腐烂前通过报错的方式强制要求同步升级相关的代码。

比如在某次升级中,name 属性被 fullName 替代了,则可以通过@deprecated特性标志:

schema Person:
    @deprecated(version="1.1.0", reason="use fullName instead", strict=True)
    name: str
    ... # Omitted contents

person = Person {
    # report an error on configing a deprecated attribute
    name: "name"
}
复制代码

这样在实例化 Person 时,name 属性的初始化语句将会及时收到报错信息。

2.4.4 内置模块、KCL模块、插件模块

KCL 是面向配置的编程语言,通过内置模块、KCL 模块和插件模块提供工程化的扩展能力。

用户代码中不用导入直接使用 builtin 的函数(比如用 len 计算列表的长度、通过 typeof 获取值的类型等),而对于字符串等基础类型也提供了一些内置方法(比如转化字符串的大小写等方法)。对于相对复杂的通用工作则通过标志库提供,比如通过 import 导入 math 库就可以使用相关的数学函数,可以通过导入 regex 库使用正则表达式库。而针对 KCL 代码也可以组织为模块,比如 Konfig 大库中将基础设施和各种标准的应用抽象为模块供上层用户使用。此外还可以通过 Plugin 机制,采用 Python 为 KCL 开发插件,比如目前有 meta 插件可以通过网络查询中心配置信息,app-context 插件则可以用于获取当前应用的上下文信息从而简化代码的编写。

3. KCL语言的实现原理

3.1 整体架构

KCL 虽然作为一个专用于云原生配置和策略定义的语言,但是保持大多数过程式和函数式编程语言的相似实现架构,其内部整体架构组成也是经典的编译器 “三段式” 架构。下面是KCL实现的架构图:

主要有以下几个关键模块:

  • 解析器 Parser:解析器分析 KCL 源代码产生 AST(抽象语法树)。
  • 编译器 Compiler:对 AST 进行多次遍历,对 AST 进行语义检查(比如进行类型检查、无效代码检查)并对 AST 进行优化(合并常量表达式等),最终产生虚拟机可以执行的字节码。
  • 虚拟机 Virtual Machine (VM):执行 Compiler 产生的字节码,计算产生相应的配置结果,并将配置结果序列化为 YAML/JSON 进行输出。

整体架构分为三段式的好处是可以把针对 KCL 源语言的前端和针对目标机器的后端组合起来,这种创建编译器组合的方法可以大大减少工作量。比如目前的 KCL 字节码定义和后端虚拟机采用自研实现,KCL 虚拟机主要用于计算产生配置结果并序列化为 YAML/JSON 进行输出。如果遇到在其他特殊使用 KCL 的场景比如在浏览器中执行 KCL,则可以重写一个适配 WASM 的后端,就可轻易将 KCL 移植到浏览器中使用,但是 KCL 本身的语法和语义不需要发生任何变化,编译器前端代码也无需任何改动。

3.2 Go和Python通信原理

为了更好地释放 KCL 配置策略语言的能力以及遍于上层自动化产品集成(比如著名的编译器后端 LLVM 就因其 API 设计良好,开发人员可以利用其 API 快速地构建自己的编程语言),KCLVM 目前提供了 Python 和 Go 两种语言的 API,使得用户可以使用相应的 API 快速地构建语言外围工具,语言自动化查询修改工具等提升语言的自动化能力,并且进一步可以基于此构建服务化能力,帮助更多的用户构建自己云原生配置代码化应用或者快速接入基础设施。

KCLVM 主体采用 Python 代码实现,而很多的云原生应用以 Go 程序构建,因此为了更好地满足云原生应用用户诉求。KCLVM 首先基于 CGo 和 CPython 构建了 Go 程序和 Python程序通信媒介,基于此设计了 Python 函数到 Go 函数的 RPC 调用,调用参数以 JSON 形式存储,使得 KCLVM-Python 编译器的能力平滑地过度到 Go 代码中,通过 Go 一行 import 调用即可操作 KCL 代码。

补充: 在服务化实践的过程中,基于CGO调用Python的方案也遇到了一些问题:首先是Go+CGO+Python导致交叉编译困难,对ACI的自动化测试和打包产生了挑战;其次是CGO之后的Python不支持多语言多线程并发,无法利用多核的性能;最后即使通过CGO将Python虚拟机编译到了Go程序中,依然还是需要安装Python的标准库和第三方库。

3.3 协同配置原理

当有了一个简单易用并能够保证稳定性的配置语言后,另一个面临的问题是如何使用配置代码化的方式提升协同能力。基于此,KCL 配置可分为用户侧和平台侧配置两类,最终的配置内容由各自用户侧和平台侧的配置内容共同决定,因此存在两个方面的协同问题:

  • 平台侧配置与用户侧配置之间的协同
  • 用户侧配置之间的协同

针对上述协同问题,KCL 在技术侧提出了顺序无关语法,同名配置合并等抽象模型来满足不同的协同配置场景。

以上图为例,首先 KCL 代码在编译过程中形成两张图(用户不同配置直接的引用和从属关系一般形式一张有向无环图),分别对应结构体内部声明代码及结构体使用声明代码。编译过程可以简单分为三步

  • 首先定义平台侧的结构体并形成结构体内部声明代码图
  • 其次声明并合并不同用户侧配置代码图
  • 最后将用户侧配置代码图计算的结果代入平台侧结构体内部声明代码图求解,最终得到完整配置图定义。

通过这样简单的计算过程,可以在编译时完成大部分代换运算,最终运行时仅进行少量计算即可得到最终的解。同时在编译合并图过程中仍然能够执行类型检查和值的检查,区别是类型检查是做泛化、取偏序上确界(检查某个变量的值是否满足既定类型或者既定类型的子类型),值检查是做特化、取偏序下确界(比如将两个字典合并为一个字典)。

4. 对未来的展望

KCL 语言目前依然处于一个高速发展的阶段,目前已经有一些应用开始试用。我们希望通过 KCL 语言为 Kusion 技术栈提供更强的能力,在运维、可信、云原生架构演进方面起到积极的作用。同时对于一些特殊的非标应用提供灵活的扩展和集成方案,比如我们正在考虑如何让后端支持 WebAssembly 平台,从而支持更多的集成方案。

在合适的时间我们希望能够开放 KCL 的全部代码,为云原生代码化的快速落地贡献绵薄之力。

谢谢大家。

更多文章请扫码关注“金融级分布式架构”公众号

文章分类
后端