Skip to main content

1 post tagged with "KCL"

查看所有标签

· 阅读需要 1 分钟

KCL 是一个 CNCF 基金会托管的基于约束的记录及函数语言,期望通过成熟的编程语言技术和实践来改进对大量繁杂配置比如云原生 Kubernetes 配置场景的编写,致力于构建围绕配置的更好的模块化、扩展性和稳定性,更简单的逻辑编写,以及更简单的自动化和生态工具集成。

本栏目将会双周更新 KCL 语言社区最新动态,包括功能、官网更新和最新的社区动态等,帮助大家更好地了解 KCL 社区!

KCL 官网:https://kcl-lang.io

内容概述

感谢所有贡献者过去两周 (2023 11.24 - 12.07) 的杰出工作,以下是重点内容概述

📦 模型更新

KCL 模型数量新增至 240 个,主要新增与 Crossplane Provider 相关的模型和与 JSON 合并操作相关的库

🔧 工具链更新

  • 文档工具更新
    • 支持模型依赖的三方库的文档生成,比如 k8s 模型
  • 验证工具更新
    • 支持验证结果和错误定位到 YAML/JSON 文件,输出错误行列号信息
  • 导入工具更新
    • 支持 OpenAPI multiplyOf 规范映射到 KCL multiplyof 函数进行校验
    • 支持 YAML Stream 格式的 Kubernetes CRD 文件输出为多个 KCL 文件
    • 优化 KCL 代码生成,去除空的 check 语句

🏄 SDK 更新

  • 在 KCL 已有 Go 和 Python SDK 的基础上新增 Rust SDK (不需要 LLVM 依赖), 初步包含 KCL 文件编译、校验、测试和格式化代码等 API

💻 IDE 更新

  • 体验改进
    • 支持增量解析和异步编译功能,提升性能
  • 错误修复
    • 修复 assert 语句中字符串插值变量不能跳转的异常
    • 修复了字符串中异常触发函数补全的异常
    • 修复 import 语句别名语义检查和补全的异常
    • 修复了 schema 中 check 表达式补全的异常

📒 文档更新

特别鸣谢

以下排名不分先后

  • 感谢 @professorabhay 支持 KCL 测试 Diff 功能 🙌
  • 感谢 @patrycju, @Callum Lyall, @Even Solberg, @Matt Gowie, @ShiroDN 在使用 KCL 过程中的交流与宝贵反馈 🙌

精选更新

在 KCL 中使用 Kubernetes Strategy Merge Patch 更新配置

在目前的 KCL 版本中支持使用各种属性运算符对配置进行更新和覆盖操作,但是能力还比较原子,无法很好地覆盖云原生常规的配置策略场景,对于 Kubernetes 配置,会频繁地使用到 Kubernetes 原生支持的 Json Merge Patch 和 Strategy Merge Patch 能力,比如使用 kubectl patch, kustomize 和大部分与云原生配置/策略工具开箱支持的 Patch 能力。

因此,为了避免在 KCL 中处理 Kubernetes 配置时反复使用 KCL 属性运算符编写配置 Patch 的模版代码,我们提供了 Kubernetes Strategy Merge Patch 库用于 Kubernetes 配置更新,并且支持所有 Kubernetes 原生对象定义的合并策略,比如列表对象的覆盖,修改和添加等。下面是使用方式

  • 新建工程并添加 Strategy Merge Patch 库依赖
kcl mod init && kcl mod add strategic_merge_patch
  • main.k 中编写配置 Patch 代码 (以 Deployment 模版的 labels, replicascontainer 字段为例)
import strategic_merge_patch as s

original = {
apiVersion = "apps/v1"
kind = "Deployment"
metadata = {
name = "my-deployment"
labels.app = "my-app"
}
spec: {
replicas = 3
template.spec.containers = [
{
name = "my-container-1"
image = "my-image-1"
}
{
name = "my-container-2"
image = "my-image-2"
}
]
}
}
patch = {
apiVersion = "apps/v1"
kind = "Deployment"
metadata = {
name = "my-deployment"
labels.version = "v1"
}
spec: {
replicas = 4
template.spec.containers = [
{
name = "my-container-1"
image = "my-new-image-1"
}
{
name = "my-container-3"
image = "my-image-3"
}
]
}
}
got = s.merge(original, patch)
  • 运行命令获得输出
kcl run

输出为

original:
apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment
labels:
app: my-app
spec:
replicas: 3
template:
spec:
containers:
- name: my-container-1
image: my-image-1
- name: my-container-2
image: my-image-2
patch:
apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment
labels:
version: v1
spec:
replicas: 4
template:
spec:
containers:
- name: my-container-1
image: my-new-image-1
- name: my-container-3
image: my-image-3
got:
apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment
labels:
app: my-app
version: v1
spec:
replicas: 4
template:
spec:
containers:
- name: my-container-1
image: my-new-image-1
- name: my-container-2
image: my-image-2
- name: my-container-3
image: my-image-3

可以看到 Deployment 模版的 labels, replicascontainer 字段都被更新为了正确的值,更多文档和使用方式请查阅 https://artifacthub.io/packages/kcl/kcl-module/strategic_merge_patch

其他资源

❤️ 感谢所有 KCL 用户和社区小伙伴在社区中提出的宝贵反馈与建议。后续我们会发布更多 KCL 云原生模型和工具集成文章,敬请期待! 查看 KCL 社区 加入我们。

更多其他资源请参考:

· 阅读需要 1 分钟

简介

KCL 团队很高兴地宣布 KCL v0.7.0 新版本现在已经可用!本次发布为大家带来了三方面的重点更新:语言工具链社区集成 & 扩展支持

  • 使用功能更完善错误更少的 KCL 语言、工具链和 IDE 提升代码编写体验和效率
  • 全新的 KCL 命令行工具,集成 KCL 包管理,doc, test 周边工具链生态,包罗万象,一键直达
  • 丰富的 KCL 三方库市场 artifacthub.io, 提供了超过 200 种 KCL 三方库,尽情挑选,无限可能

进一步您可以在 KCL v0.7.0 发布页面 或者 KCL 官方网站 获得下载安装指南和详细发布信息。

KCL 是一个 CNCF 基金会托管的面向云原生领域开源的基于约束的记录及函数编程语言,期望通过成熟的编程语言技术和实践来改进对大量繁杂配置比如云原生 Kubernetes 配置场景的编写,致力于围绕配置的模块化、扩展性和稳定性,打造更简单的逻辑编写体验,构建更简单的自动化和生态集成路径。

本文重点介绍 KCL v0.7.0 版本的更新内容以及 KCL 社区的近期动态。

语言更新

⭐️ 全新的 KCL 命令行工具

在新版本中提供了全新的 KCL 命令行工具, 目标是将 KCL 周边生态囊括在一起,为您提供统一简明的操作页面,包罗万象,一键直达。

新的 KCL 命令行工具将会以继续 kcl 作为命令前缀,目前提供包含编译,包管理,格式化工具等多个子命令。

cli-help

🔧 诊断信息的优化

在 KCL 新版本中,在部分代码错误信息中增加了修复建议,比如变量名称写错或者查找不到 import 的代码包

import sub as s1

The_first_kcl_program = s.The_first_kcl_program

did you mean

try-kcl-mod-add

🚀 语言编写体验优化

去掉了部分代码块中的缩进检查

在 KCL 新版本中,我们取消了配置代码块的严格缩进检查,如果 KCL 代码写成这样

schema TestIndent:
name: str
msg: str
id: int

test_indent = TestIndent {
name = "test"
msg = "test"
id = 1
}

使用 kcl fmt 命令会可以一键格式化

kcl-fmt

函数类型注解

在 KCL 新版本中,新增了函数类型注解,您可以在新版本的 KCL 中编写如下带有类型注解的 lambda。

schema Test:
name: str

identity: (Test) -> bool = lambda res: Test -> bool {
res.name == "hello"
}

c = identity(Test { name = "hello" })

🏄 API 更新

🐞 其他更新及错误修复

IDE & 工具链更新

IDE 更新

KCL IDE 插件支持了对符号的引用跳转及重命名功能

IDE 增加了对符号的引用跳转支持,使用转到引用查找所有引用

find-ref

对符号进行重命名

rename

IDE 支持对引用语句和联合类型的格式化

优化了引用语句与其他代码块之间的空行行为(格式化为一个空行)和联合类型的空格行为(多个类型之间格式化为以 | 间隔):

fmt

KCL IDE 插件基于新增了大量补全提示

针对配置定义这一核心环节,简化用户基于模型编写配置的心智、提升配置编辑的效率。此外,增强了调用内置函数时参数补全。talk is cheap,我们直接来看效果:

func-completion

conf-completion

而对于模型设计环节,也新增了对 docstring 的快速生成,减少手敲 boilerplate:

gen-docstring

性能提升

  • KCL 设计并重构了新的语义模型以及支持最近符号查找和符号语义信息查询 API
  • IDE 补全,跳转和悬停等功能实现迁移至新语义模型,显著降低 IDE 功能开发难度和代码量
  • KCL 编译器支持语法增量解析以及语义增量检查,大部分场景提升 KCL 编译构建和 IDE 插件使用性能 5-10 倍

其他更新和错误修复

  • KCL IntelliJ 插件适配 2023.2+ 版本
  • 支持对标准库和内置函数的悬停提示,支持对 KCL 代码错误的快速修复
  • 优化了对引用语句和 union 类型的格式化输出。
  • 修复了语言服务虚拟文件系统相关的bug:文件维度的变更引发会语言服务崩溃,必须重启 IDE 恢复,现已修复。
  • 支持包管理工具引入的外部包依赖 import 语句补全
  • 修复函数参数未定义类型错误显示位置

测试工具更新

担心您的 KCL 程序写错了,要不来测测 ?本次更新提供了全新的 KCL 测试工具,代码好坏,一测便知 !新的 KCL 测试工具支持使用 KCL 函数编写单元测试并使用工具执行测试。

您可以在后缀名为 “_test.k” 文件中通过 lambda 表达式来编写您的测试用例。

import .app

# Convert the `App` model into Kubernetes Deployment and Service Manifests
test_kubernetesRender = lambda {
a = app.App {
name = "app"
containers.ngnix = {
image = "ngnix"
ports = [{containerPort = 80}]
}
service.ports = [{ port = 80 }]
}
deployment_got = kubernetesRender(a)
assert deployment_got[0].kind == "Deployment"
assert deployment_got[1].kind == "Service"
}

通过 kcl test 命令可以运行这个测试用例并查看测试结果。

测试通过会将得到如下结果:

test-pass

如果测试失败了,kcl test 会将输出错误信息进行输出。

test-failed

KCL 包管理工具

新增 update 命令用于自动更新本地依赖,使用 kcl mod update 将会自动下载本地缺失的三方库。具体参考: https://github.com/kcl-lang/kpm/pull/212

KCL 导入工具发布

支持从 YAML/JSON/CRD/Terraform Schema 一键生成 KCL 配置/模型,实现自动化迁移。

如果您有如下 yaml 文件:

apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
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 import test.yaml 您可以将其转换为 KCL 程序。

"""
This file was generated by the KCL auto-gen tool. DO NOT EDIT.
Editing this file might prove futile when you re-run the KCL auto-gen generate command.
"""

apiVersion = "apps/v1"
kind = "Deployment"
metadata = {
name = "nginx-deployment"
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
}
]
}
]
}
}
}

更多详细内容请参考一键从 Kubernetes 生态迁移到 KCL

社区集成 & 扩展更新

KCL 三方库市场 ArtifactHub

通过集成 artifacthub.io 我们构建了一个 KCL 三方库市场,在这里您尽可以大展您的才华,与我们一同分享您对 KCL 程序的独特理解,您也可以尽情挑选,找到适合您自己的 KCL 三方库 !

打开首页,直接搜索您需要的关键字,就能看到关于 KCL 三方库的相关内容 !

artifachub-index

在三方库首页,可以查看关于三方库的详细内容和相关文档。

pkg-page

如果您不知道该如何使用这些三方库,右侧的按钮可以为您唤起安装页面。

install-pkg

欢迎大家来 artifacthub.io 为 KCL 社区贡献您的三方库,让 KCL 社区变得更加丰富多彩!

贡献指南:https://kcl-lang.io/docs/user_docs/guides/package-management/how-to/publish_pkg_to_ah

其他更新

完整更新和错误修复列表详见: https://github.com/kcl-lang/kcl/compare/v0.6.0...v0.7.0

文档更新

KCL 网站新增 KCL v0.7.0 文档内容并支持版本化语义选项,目前支持 v0.4.x, v0.5.x, v0.6.x 和 v0.7.0 版本选择,同时欢迎社区同学进行文档共建。

社区动态

KCL 正式成为 CNCF 沙箱项目

🎉 🎉 🎉 2023 年 9 月 20 日,KCL 项目通过了全球顶级开源基金会云原生计算基金会(CNCF)技术监督委员会评定,正式成为 CNCF 沙箱项目。

更多详情详见: https://kcl-lang.io/blog/2023-09-19-kcl-joining-cncf-sandbox/

特别鸣谢

感谢社区的小伙伴在 KCL v0.7.0 版本中的贡献,以下排名不分先后

下一步计划

感谢所有 KCL 用户和社区小伙伴在此次版本更新过程中提出的宝贵反馈与建议。预计 2024 年 2 月,我们将发布 KCL v0.8.0 版本,更多详情请参考 KCL 2024 路线规划 和 KCL v0.8.0 Milestone,如果您有更多的想法和需求,欢迎在 KCL Github 仓库发起 Issues 或讨论,也欢迎加入我们的社区进行交流 🙌 🙌 🙌

更多其他资源请参考: