Skip to content

Commit e29c00d

Browse files
PeefyPeefy
committed
feat: add helmfile kcl plugin blogs
1 parent 2fae868 commit e29c00d

File tree

3 files changed

+261
-0
lines changed
  • blog/2023-08-31-helmfile-kcl-plugin
  • i18n/zh-CN/docusaurus-plugin-content-blog/2023-08-31-helmfile-kcl-plugin
  • static/img/blog/2023-08-31-helmfile-kcl-plugin

3 files changed

+261
-0
lines changed

‎blog/2023-08-31-helmfile-kcl-plugin/index.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
slug: 2023-08-31-helmfile-kcl-plugin
3+
title: 5-Minute Gameplay with Helmfile KCL Plugin for Easy Management of Kubernetes Helm Charts
4+
authors:
5+
name: KCL Team
6+
title: KCL Team
7+
tags: [KCL, Biweekly-Newsletter]
8+
---
9+
10+
## What is KCL
11+
12+
[KCL](https://github.com/kcl-lang) is an open-source, constraint-based record and functional language that enhances the writing of complex configurations, including those for cloud-native scenarios. With its advanced programming language technology and practices, KCL is dedicated to promoting better modularity, scalability, and stability for configurations. It enables simpler logic writing and offers ease of automation APIs and integration with homegrown systems.
13+
14+
## What is Helmfile
15+
16+
Helmfile is a declarative specification and tool for simplifying and managing Helm Charts. The Helmfile KCL Plugin provides additional functionality to the Helmfile tool, making it more convenient and efficient to use. With the Helmfile KCL Plugin, you can:
17+
18+
+ Edit or validate Helm Chart configurations directly on the client-side using non-intrusive hooks. This allows you to separate the data and logic parts of Kubernetes configuration management without needing to fork the upstream Chart to modify internal logic include modifying resource labels/annotations and injecting Sidecar container configurations.
19+
+ Validate Kubernetes resources using KCL Schema, define your own abstract models, and share them for reusability.
20+
21+
In this blog, we will quickly guide you through getting started with the Helmfile KCL Plugin, enabling you to easily manage your Kubernetes Helm Charts.
22+
23+
We will explain in detail using a simple example. With the Helmfile KCL Plugin, you do not need to install any components related to KCL. You only need the latest version of the Helmfile tool (v0.156.0+) on your local machine.
24+
25+
## Using the Helmfile KCL Plugin
26+
27+
### 1. Tool Installation
28+
29+
First, make sure you have installed the Helmfile client tool. You can follow the instructions in the documentation link below.
30+
31+
https://github.com/helmfile/helmfile
32+
33+
### 2. Create the Helmfile Configuration File
34+
35+
Create a file named helmfile.yaml in the root directory of your project and write the configuration using Helmfile syntax. In this file, you can specify the Helm Charts to use, configuration values, and any other functionality supported by Helmfile. Additionally, you can use the features of the KCL Plugin in helmfile.yaml to load configurations and make in-place modifications and validations to the Helm Chart.
36+
37+
```yaml
38+
repositories:
39+
- name: prometheus-community
40+
url: https://prometheus-community.github.io/helm-charts
41+
releases:
42+
- name: prom-norbac-ubuntu
43+
namespace: prometheus
44+
chart: prometheus-community/prometheus
45+
set:
46+
- name: rbac.create
47+
value: false
48+
transformers:
49+
# Use KCL Plugin to mutate or validate Kubernetes manifests.
50+
- apiVersion: krm.kcl.dev/v1alpha1
51+
kind: KCLRun
52+
metadata:
53+
name: "set-annotation"
54+
annotations:
55+
config.kubernetes.io/function: |
56+
container:
57+
image: docker.io/kcllang/kustomize-kcl:v0.2.0
58+
spec:
59+
source: |
60+
# A single line of KCL code can be used to modify workload configurations in-place.
61+
items = [resource | {if resource.kind == "Deployment": metadata.annotations: {"managed-by" = "helmfile-kcl"}} for resource in option("resource_list").items]
62+
```
63+
64+
In the above configuration, we reference the Prometheus Helm Chart and use a single line of KCL code to inject the label `managed-by="helmfile-kcl"` to all the Deployment resources of Prometheus.
65+
66+
### 3. Run the Helmfile Tool
67+
68+
Once everything is set up, you can run the Helmfile command to deploy, manage, and maintain your Helm Charts. Use the following command to apply the configuration mentioned above to the cluster.
69+
70+
```shell
71+
helmfile apply
72+
```
73+
74+
You should see the following output if everything goes well:
75+
76+
```shell
77+
Adding repo prometheus-community https://prometheus-community.github.io/helm-charts
78+
"prometheus-community" has been added to your repositories...
79+
80+
...
81+
```
82+
83+
## Want More?
84+
85+
For the above helmfile configuration, you can encapsulate it as a reusable logic for configuration modification without constantly writing and copying/pasting KCL code. Additionally, many commonly used Kubernetes configuration editing and validation code snippets are already packaged in the KCL official Registry: https://github.com/orgs/kcl-lang/packages
86+
87+
![registry](/img/blog/2023-08-31-helmfile-kcl-plugin/registry.png)
88+
89+
In addition to supporting writing KCL code in configuration files, we also support directly referencing code snippets in Registry, as shown below
90+
91+
```yaml
92+
apiVersion: krm.kcl.dev/v1alpha1
93+
kind: KCLRun
94+
metadata:
95+
name: https-only
96+
annotations:
97+
krm.kcl.dev/version: 0.0.1
98+
krm.kcl.dev/type: validation
99+
documentation: >-
100+
Requires Ingress resources to be HTTPS only. Ingress resources must
101+
include the `kubernetes.io/ingress.allow-http` annotation, set to `false`.
102+
By default a valid TLS {} configuration is required, this can be made
103+
optional by setting the `tlsOptional` parameter to `true`.
104+
More info: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls
105+
spec:
106+
# Use the OCI source
107+
source: oci://ghcr.io/kcl-lang/https-only
108+
```
109+
110+
Specific example codes can be found [here](https://github.com/kcl-lang/krm-kcl/tree/main/examples)
111+
112+
If you want to contribute more KCL code repositories, feel free to contact us and refer to the documentation for contribution: https://kcl-lang.io/zh-CN/docs/user_docs/guides/package-management/share_your_pkg/
113+
114+
## Conclusion
115+
116+
This blog provided a quick getting started guide to help you master the basics of the Helmfile KCL Plugin in just 5 minutes. Now, you can start using this powerful tool to simplify and optimize your Kubernetes application deployment process!
117+
118+
## Resources
119+
120+
For more resources, please refer to
121+
122+
- [KCL Website](https://kcl-lang.io/)
123+
- [KusionStack Website](https://kusionstack.io/)
124+
125+
- [KCL 2023 Roadmap](https://kcl-lang.io/docs/community/release-policy/roadmap)
126+
- [KCL v0.6.0 Milestone](https://github.com/kcl-lang/kcl/milestone/6)
127+
- [KCL Github Issues](https://github.com/kcl-lang/kcl/issues)
128+
- [KCL Github Discussion](https://github.com/orgs/kcl-lang/discussions)
129+
- [KCL Community](https://github.com/kcl-lang/community)

‎i18n/zh-CN/docusaurus-plugin-content-blog/2023-08-31-helmfile-kcl-plugin/index.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
slug: 2023-08-31-helmfile-kcl-plugin
3+
title: 5 分钟玩转 Helmfile KCL 插件，轻松管理 Kubernetes Helm Charts
4+
authors:
5+
name: KCL 团队
6+
title: KCL 团队
7+
tags: [KCL, Biweekly-Newsletter]
8+
---
9+
10+
## 什么是 KCL
11+
12+
[KCL](https://github.com/kcl-lang) 是一个开源的基于约束的记录及函数语言并通过成熟的编程语言技术和实践来改进对大量繁杂配置比如云原生 Kubernetes 配置场景的编写，致力于构建围绕配置的更好的模块化、扩展性和稳定性，更简单的逻辑编写，以及更简单的自动化和生态工具集成。
13+
14+
## 什么是 Helmfile
15+
16+
Helmfile 是一个是用于简化和管理 Helm Charts 的声明性规范和工具，Helmfile KCL 插件为 Helmfile 工具提供了额外的功能，使得在使用 Helmfile 时更加便捷和高效，通过 Helmfile KCL 插件您可以
17+
18+
+ 通过无侵入的 Hook 方式在客户端直接编辑或者验证 Helm Chart 配置，将 Kubernetes 配置管理的数据部分和逻辑部分分离，无需 Fork 上游 Chart 修改内部逻辑，比如
19+
+ 修改资源标签/注解, 注入 Sidecar 容器配置
20+
+ 使用 KCL Schema 校验 Kubernetes 资源，定义自己的抽象模型并分享复用
21+
+ 优雅地维护多环境、多租户场景配置，而不是简单地复制粘贴
22+
23+
在本文中，我们将带您快速了解和入门 Helmfile KCL 插件，让您轻松管理您的 Kubernetes Helm Charts。
24+
25+
下面以一个简单示例进行详细说明，使用 Helmfile KCL 插件无需您安装与 KCL 任何相关的组件，只需本机具备 Helmfile 工具的最新版本（v0.156.0+）即可。
26+
27+
## 使用 Helmfile KCL 插件
28+
29+
### 1. 工具安装
30+
31+
首先，确保您已经安装了 Helmfile 客户端工具，可以根据下面链接中的文档提示进行安装。
32+
33+
https://github.com/helmfile/helmfile
34+
35+
### 2. 创建 Helmfile 配置文件
36+
37+
在您的项目根目录中创建一个名为 helmfile.yaml 的文件，并按照 Helmfile 的语法编写配置。在这个文件中，您可以指定要使用的 Helm Charts、配置值和任何其他 Helmfile 支持的功能。此外，您还可以在 helmfile.yaml 中使用 KCL 插件的功能来加载对 Helm Chart 进行原地配置修改和验证
38+
39+
```yaml
40+
repositories:
41+
- name: prometheus-community
42+
url: https://prometheus-community.github.io/helm-charts
43+
44+
releases:
45+
- name: prom-norbac-ubuntu
46+
namespace: prometheus
47+
chart: prometheus-community/prometheus
48+
set:
49+
- name: rbac.create
50+
value: false
51+
transformers:
52+
# Use KCL Plugin to mutate or validate Kubernetes manifests.
53+
- apiVersion: krm.kcl.dev/v1alpha1
54+
kind: KCLRun
55+
metadata:
56+
name: "set-annotation"
57+
annotations:
58+
config.kubernetes.io/function: |
59+
container:
60+
image: docker.io/kcllang/kustomize-kcl:v0.2.0
61+
spec:
62+
source: |
63+
# 仅通过一行 KCL 代码，就可实现对 workload 配置原地修改
64+
items = [resource | {if resource.kind == "Deployment": metadata.annotations: {"managed-by" = "helmfile-kcl"}} for resource in option("resource_list").items]
65+
```
66+
67+
在上述配置中，我们引用了 Prometheus Helm Chart, 并通过一行 KCL 代码就可以完成 Prometheus 的所有的 Deployment 资源注入标签 managed-by="helmfile-kcl"。
68+
69+
### 3. 运行 Helmfile 工具
70+
71+
一切准备就绪后，您可以运行 Helmfile 命令来部署、管理和维护您的 Helm Charts，通过如下命令我们可以将上述配置下发到集群。
72+
73+
```shell
74+
helmfile apply
75+
```
76+
77+
正常情况我们会看到如下面所示的输出
78+
79+
```shell
80+
Adding repo prometheus-community https://prometheus-community.github.io/helm-charts
81+
"prometheus-community" has been added to your repositories...
82+
83+
...
84+
```
85+
86+
## 想要更多?
87+
88+
对于上述 helmfile 配置，我们可以将其封装为常用的配置修改逻辑并使用，无需不断重复编写 KCL 代码并到处复制粘贴。此外，我们在 KCL 官方 Registry 已经封装好了许多常用的 Kubernetes 配置编辑和校验代码片段 https://github.com/orgs/kcl-lang/packages
89+
90+
![registry](/img/blog/2023-08-31-helmfile-kcl-plugin/registry.png)
91+
92+
除了支持在配置文件中书写 KCL 代码，我们还支持直接引用 Registry 中的代码片段，如下所示
93+
94+
```yaml
95+
apiVersion: krm.kcl.dev/v1alpha1
96+
kind: KCLRun
97+
metadata:
98+
name: https-only
99+
annotations:
100+
krm.kcl.dev/version: 0.0.1
101+
krm.kcl.dev/type: validation
102+
documentation: >-
103+
Requires Ingress resources to be HTTPS only. Ingress resources must
104+
include the `kubernetes.io/ingress.allow-http` annotation, set to `false`.
105+
By default a valid TLS {} configuration is required, this can be made
106+
optional by setting the `tlsOptional` parameter to `true`.
107+
More info: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls
108+
spec:
109+
# Use the OCI source
110+
source: oci://ghcr.io/kcl-lang/https-only
111+
```
112+
113+
具体的示例代码在[这里](https://github.com/kcl-lang/krm-kcl/tree/main/examples)
114+
115+
如果您想贡献更多的 KCL 代码库，欢迎联系我们并参阅文档进行贡献 https://kcl-lang.io/zh-CN/docs/user_docs/guides/package-management/share_your_pkg/
116+
117+
## 小结
118+
119+
本文提供了一个快速入门指南，帮助您在 5 分钟内掌握 Helmfile KCL 插件的基本用法。现在，您可以开始使用这个强大的工具来简化和优化您的 Kubernetes 应用部署流程了！
120+
121+
## 其他资源
122+
123+
更多其他资源请参考：
124+
125+
- [KCL 网站](https://kcl-lang.io/)
126+
- [KusionStack 网站](https://kusionstack.io/)
127+
128+
- [KCL 2023 路线规划](https://kcl-lang.io/docs/community/release-policy/roadmap)
129+
- [KCL v0.6.0 Milestone](https://github.com/kcl-lang/kcl/milestone/6)
130+
- [KCL Github Issues](https://github.com/kcl-lang/kcl/issues)
131+
- [KCL Github Discussion](https://github.com/orgs/kcl-lang/discussions)
132+
- [KCL Community](https://github.com/kcl-lang/community)

‎static/img/blog/2023-08-31-helmfile-kcl-plugin/registry.png‎

357 KB
Loading

0 commit comments

Comments
 (0)