什么是 KCL

KCL (Kusion Configuration Language) [https://github.com/KusionStack/KCLVM是一个开源的基于约束的记录及函数语言,主要用于配置编写和策略校验场景。KCL 期望通过成熟的编程语言技术和实践来改进对大量繁杂配置的编写,致力于构建围绕配置的更好的模块化、扩展性和稳定性,更简单的逻辑编写,以及更快的自动化集成和良好的生态延展性。

所谓配置就是当我们部署软件系统时,我们并不认为它们是固定不变的。不断发展的业务需求、基础架构要求和其他因素意味着系统不断变化。当我们需要快速更改系统行为,并且更改过程需要昂贵、冗长的重建和重新部署过程时,业务代码更改往往是不够的。而配置可以为我们提供了一种低开销的方式来改变系统功能,比如我们会经常为系统编写一些如下所示的 JSON 或 YAML 文件作为我们系统的配置。

JSON 配置

{
   “server”: {
       “addr”: “127.0.0.1”,
       “listen”: 4545
   },
   “database”: {
       “enabled”: true,
       “ports”: [
           8000,
           8001,
           8002
       ],
   }
}

YAML 配置

server:
 addr: 127.0.0.1
 listen: 4545
database:
 enabled: true
 ports:
  8000
  8001
  8002

 

我们可以根据需要选择在 JSON 和 YAML 文件中存储静态配置。此外,配置还可以存储在允许更灵活配置的高级语言中,通过代码编写、渲染并得到静态配置。KCL 就是这样一种配置语言,我们可以编写 KCL 代码来生成 JSON/YAML 等配置。这篇文章我们重点讲述使用 KCL 生成并管理 Kubernetes 资源,并通过一些简单的例子给大家一个简单的快速开始,更多的内容我们会在后续文章展开。

为什么使用 KCL

当我们管理 Kubernetes 资源清单时,我们常常会手写维护,或者使用 Helm 和 Kustomize 等工具来维护我们 YAML 配置或者配置模版,然后通过 kubectl 和 helm 命令行等工具将资源下发到集群。但是作为一个 “YAML 工程师” 每天维护 YAML 配置无疑是琐碎且无聊的,并且容易出错。

apiVersion: apps/v1
kind: Deployment
metadata: # Omit
spec:
 selector:
   matchlabels:
     cell: RZ00A
 replicas: 2
 template:
   metadata: # Omit
   spec:
     tolerations:
      effect: NoSchedules
       key: isoverquota
       operator: Equal
       value: ‘true’
     containers:
      name: testapp
         image: images.example/app:v1 # Wrong ident
       resources:
         limits:
           cpu: 2 # Wrong type. The type of cpu should be str
           memory: 4Gi
           # Field missing: ephemeral-storage
     affinity:
       nodeAffinity:
         requiredDuringSchedulingIgnoredDuringExecution:
           nodeSelectorTerms:
            matchExpressions:
              key: isoverquota
               operator: In
               values:
                ‘true’

 

1. YAML 中的结构化数据是无类型的,缺乏验证方法,无法立即检查所有数据的有效性

2. YAML 编程能力欠佳,容易写出不正确的缩进,也没有逻辑判断、等常见代码组织方式,容易写出大量重复配置,难以维护

3. 用户很难理解 YAML 配置所有细节,比如上 Kubernetes 配置中的 toleration 和 affinity 字段,如果用户不理解调度逻辑,它可能被错误地省略掉或者多余的添加

因此,KCL 期望在 Kubernetes YAML 资源管理层面解决如下问题:

1. 用生产级高性能编程语言编写代码的方式提升配置的灵活度,比如条件语句、循环、函数、包管理等特性提升配置重用的能力

2. 在代码层面提升配置语义验证的能力,比如字段可选 / 必选、类型、范围等配置检查能力

3. 提供配置分块编写、组合和抽象的能力,比如结构定义、结构继承、约束定义等能力

本篇文章是 KCL 可以做什么系列文章第一篇,重点讲述 KCL 快速入门,后续会持续更新和分享 KCL 的一系列特点和使用场景,大家敬请期待!

如何使用 KCL 生成并管理 Kubernetes 资源

 

前提条件

首先可以在 KCL 项目首页 https://github.com/KusionStack/KCLVM 根据指导下载并安装 KCL,然后准备一个 Kubernetes 环境

生成 Kubernetes 资源

我们可以编写如下 KCL 代码并命名为 main.k ,KCL 受 Python 启发,基础语法十分接近 Python, 比较容易学习和上手

apiVersion = “apps/v1”
kind = “Deployment”
metadata = {
   name = “nginx”
   labels.app = “nginx”
}
spec = {
   replicas = 3
   selector.matchLabels = metadata.labels
   template.metadata.labels = metadata.labels
   template.spec.containers = [
       {
           name = metadata.name
           image = “${metadata.name}:1.14.2”
           ports = [{ containerPort = 80 }]
       }
   ]
}

上述 KCL 代码中我们分别声明了一个 Kubernets Deployment 资源的 apiVersionkindmetadata 和 spec 等变量,并分别赋值了相应的内容,特别地,我们将 metadata.labels 字段分别重用在 spec.selector.matchLabels 和 spec.template.metadata.labels 字段。可以看出,相比于 YAML,KCL 定义的数据结构更加紧凑,而且可以通过定义局部变量实现配置重用。

我们可以执行如下命令行得到一个 Kubernetes YAML 文件

kcl main.k

输出为:

apiVersion: apps/v1
kind: Deployment
metadata:
 name: nginx
 labels:
   app: nginx
spec:
 replicas: 3
 selector:
   matchLabels:
     app: nginx
 template:
   metadata:
     labels:
       app: nginx
   spec:
     containers:
      name: nginx
       image: nginx:1.14.2
       ports:
        containerPort: 80

当然我们可以将 KCL 工具与 kubectl 等工具结合使用,让我们执行如下命令并看看效果

$ kcl main.k | kubectl apply -f –

deployment.apps/nginx configured

可以从命令行的结果看出看出与我们使用直接使用 YAML 配置和 kubectl apply 的一个 Deployment 体验完全一致

通过 kubectl 检查部署状态

$ kubectl get deploy

NAME    READY   UP-TO-DATE   AVAILABLE   AGE
nginx   3/3     3            3           15s

 

编写代码管理 Kubernetes 资源

对于 Kubernetes 资源发布时,我们常常会遇到配置参数需要动态指定的场景,比如不同的环境需要设置不同的 image 字段值生成不同环境的资源。对于这种场景,我们可以通过 KCL 的条件语句和 option 函数动态地接收外部参数。我们可以在上述例子的基础上根据不同的环境调整配置参数,比如对于如下代码,我们编写了一个条件语句并输入一个名为 env 的动态参数

apiVersion = “apps/v1”
kind = “Deployment”
metadata = {
   name = “nginx”
   labels.app = “nginx”
}
spec = {
   replicas = 3
   selector.matchLabels = metadata.labels
   template.metadata.labels = metadata.labels
   template.spec.containers = [
       {
           name = metadata.name
           image = “${metadata.name}:1.14.2” if option(“env”) == “prod” else ${metadata.name}:latest”
           ports = [{ containerPort = 80 }]
       }
   ]
}

 

使用 KCL 命令行 -D 标记接收一个从外部设置的动态参数:

kcl main.k -D env=prod

输出为:

apiVersion: apps/v1
kind: Deployment
metadata:
 name: nginxdeployment
 labels:
   app: nginx
spec:
 replicas: 3
 selector:
   matchLabels:
     app: nginx
 template:
   metadata:
     labels:
       app: nginx
   spec:
     containers:
      name: nginx
       image: nginx:1.14.2
       ports:
        containerPort: 80

上述代码片段中的 image = “${metadata.name}:1.14.2” if option(“env”) == “prod” else “${metadata.name}:latest” 意思为:当动态参数 env 的值被设置为 prod 时,image 字段值为 nginx:1.14.2, 否则为 nginx:latest,因此我们可以根据需要为 env 设置为不同的值获得不同内容的 Kubernetes 资源。

并且 KCL 支持将 option 函数动态参数维护在配置文件中,比如编写下面展示的 kcl.yaml 文件

kcl_options:
  key: env
   value: prod

使用如下命令行也可以得到同样的效果,简化 KCL 动态参数的输入过程

kcl main.k -Y kcl.yaml

输出为:

apiVersion: apps/v1
kind: Deployment
metadata:
 name: nginxdeployment
 labels:
   app: nginx
spec:
 replicas: 3
 selector:
   matchLabels:
     app: nginx
 template:
   metadata:
     labels:
       app: nginx
   spec:
     containers:
      name: nginx
       image: nginx:1.14.2
       ports:
        containerPort: 80

 

下一期

 

本期内容大概简单介绍了用 KCL 编写配置的快速入门和使用 KCL 定义并管理 Kubernetes 资源。

目前阶段 Kustomize 和 Helm 已经慢慢演进成在 Kubernetes 配置定义和管理领域的事实意义上的标准,熟悉 Kubernetes 的小伙伴可能更喜欢显式配置编写方式编写。那么相较于 Kustomize 和 Helm,用 KCL 来写配置文件渲染,又有什么异同呢?考虑到有很多小伙伴已经在使用 Helm,Kustomize 这样的工具,下一期我将介绍用 KCL 的方式来写对应的配置代码,敬请期待!!

如果您喜欢这篇文章,一定记得收藏 + 关注!!更多精彩内容请访问: 

KCL 仓库地址:https://github.com/KusionStack/KCLVM

Kusion 仓库地址:https://github.com/KusionStack/kusion

Konfig 仓库地址:https://github.com/KusionStack/Konfig

同时欢迎加入我们的社区进行交流:

https://github.com/KusionStack/community

 

作者

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Generated by Feedzy
%d 博主赞过: