Skip to content

Commit 22ca337

Browse files
MacroPowerMacroPower
committed
Only use zig for crossbuilding
1 parent 6204808 commit 22ca337

9 files changed

+164
-196
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Also works with [Renovate](https://github.com/renovatebot/renovate)! You can fin
9999

100100
---
101101

102-
**Enjoy blazing-fast reconciliation times.** Kclipper is built with performance in mind and is optimized for speedy rendering at runtime. It achieves this with a custom Helm template implementation, based on the Argo CD Helm source implementation, with edits to minimize I/O. Additionally, using schemaValidator="KCL" disables Helm's value validation and instead relies on KCL for values validation. This can provide a significant performance boost for any chart that includes a proper JSON Schema, and is especially noticeable for charts with nested JSON Schemas (e.g., remote refs, chart dependencies, or both).
102+
**Enjoy blazing-fast reconciliation times.** Kclipper is built with performance in mind and is optimized for speedy rendering at runtime. It achieves this with a custom Helm template implementation, based on the Argo CD Helm source implementation, with edits to minimize I/O.
103103

104104
| Chart | Vanilla Argo CD | kclipper | kclipper (schemaValidator=KCL) |
105105
| :----------- | :-------------- | :--------- | :----------------------------- |
@@ -108,7 +108,7 @@ Also works with [Renovate](https://github.com/renovatebot/renovate)! You can fin
108108

109109
> Approximate values from my Mac Mini M2.
110110
111-
There is a bit of a trade-off. The binary size is larger, and KCL initialization will be slower by an small, absolute amount of time. Meaning, KCL runs with no Helm templates will be slightly slower compared to upstream KCL. See [benchmarks](./benchmarks) for more details.
111+
See [benchmarks](./benchmarks) for more details.
112112

113113
---
114114

‎Taskfile.yaml

+23-25
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ env:
2020
CXX_LINUX_ARM64: zig c++ -target aarch64-linux-gnu
2121
CXX_DARWIN_AMD64: zig c++ -target x86_64-macos-none -F{{ .FRAMEWORK_PATH }}
2222
CXX_DARWIN_ARM64: zig c++ -target aarch64-macos-none -F{{ .FRAMEWORK_PATH }}
23-
BUILD_TAGS: netgo,rpc
23+
BUILD_TAGS: netgo,rpc,extended
2424

2525
tasks:
2626
default:
@@ -70,10 +70,9 @@ tasks:
7070
go-test:
7171
desc: Tests Go code
7272
cmds:
73-
- |
74-
export CC=$CC_{{.C_ENV}} CXX=$CXX_{{.C_ENV}}
75-
mkdir -p .test/
76-
go test -vet=all -coverprofile=.test/cover.out -tags={{.BUILD_TAGS}} ./...
73+
- cmd: mkdir -p .test/
74+
silent: true
75+
- go test -vet=all -coverprofile=.test/cover.out -tags={{.BUILD_TAGS}} ./...
7776

7877
go-bench:
7978
desc: Run Go benchmarks
@@ -90,16 +89,12 @@ tasks:
9089
PKG: '{{.PKG | default "./..."}}'
9190
FLAGS: '{{.FLAGS | default ""}}'
9291
cmds:
93-
- |
94-
export CC=$CC_{{.C_ENV}} CXX=$CXX_{{.C_ENV}}
95-
go test -ldflags="-s -w" -bench=. -benchmem -tags={{.BUILD_TAGS}} {{.FLAGS}} {{.PKG}}
92+
- go test -bench=. -benchmem -tags={{.BUILD_TAGS}} {{.FLAGS}} {{.PKG}}
9693

9794
go-gen:
9895
desc: Generates Go code
9996
cmds:
100-
- |
101-
export CC=$CC_{{.C_ENV}} CXX=$CXX_{{.C_ENV}}
102-
go generate ./...
97+
- go generate ./...
10398

10499
go-build:
105100
desc: Builds Go binaries
@@ -142,21 +137,24 @@ tasks:
142137
FLAGS: "--single-target"
143138
- task: pull-upstream
144139
vars:
145-
KCLX_BIN: dist/kclipper_{{OS}}_{{ARCH}}*/kcl
146-
KCL_CODE: benchmarks/no-charts.k
147-
KCL_HELM: benchmarks/10-charts.k
148-
KCL_HELM_VALUES: benchmarks/10-charts-with-values.k
140+
KCLX_BIN: ../dist/kclipper_{{OS}}_{{ARCH}}*/kcl
141+
KCL_CODE: no-charts.k
142+
KCL_HELM: 10-charts.k
143+
KCL_HELM_VALUES: 10-charts-with-values.k
149144
cmds:
150-
- >-
151-
hyperfine --warmup=50 --min-runs=1000
152-
--export-markdown ./benchmarks/README.md
153-
--command-name "kclipper ./{{.KCL_CODE}}"
154-
--command-name "kclipper ./{{.KCL_HELM}}"
155-
--command-name "kclipper ./{{.KCL_HELM_VALUES}}"
156-
--reference ".tmp/bin/kcl ./{{.KCL_CODE}}"
157-
"{{.KCLX_BIN}} ./{{.KCL_CODE}}"
158-
"{{.KCLX_BIN}} ./{{.KCL_HELM}}"
159-
"{{.KCLX_BIN}} ./{{.KCL_HELM_VALUES}}"
145+
- cp ./.tmp/bin/kcl ./benchmarks/kcl
146+
- defer: rm ./benchmarks/kcl
147+
- |-
148+
cd benchmarks
149+
hyperfine --warmup=50 --min-runs=1000 \
150+
--export-markdown ./README.md \
151+
--command-name "kcl(ipper) -V {{.KCL_CODE}}" \
152+
--command-name "kcl(ipper) -V {{.KCL_HELM}}" \
153+
--command-name "kcl(ipper) -V {{.KCL_HELM_VALUES}}" \
154+
--reference "kcl -V {{.KCL_CODE}}" \
155+
"{{.KCLX_BIN}} -V {{.KCL_CODE}}" \
156+
"{{.KCLX_BIN}} -V {{.KCL_HELM}}" \
157+
"{{.KCLX_BIN}} -V {{.KCL_HELM_VALUES}}"
160158
161159
bench-diff-docker:
162160
desc: Compares benchmark results

‎benchmarks/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
vendor/
2+
kcl

‎benchmarks/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
2-
| :---------------------------------------------- | ---------: | -------: | -------: | ----------: |
3-
| `.tmp/bin/kcl ./benchmarks/no-charts.k` | 46.0 ± 2.4 | 43.5 | 82.7 | 1.00 |
4-
| `kclipper ./benchmarks/no-charts.k` | 58.5 ± 2.6 | 56.2 | 94.5 | 1.27 ± 0.09 |
5-
| `kclipper ./benchmarks/10-charts.k` | 80.4 ± 2.9 | 77.3 | 116.3 | 1.75 ± 0.11 |
6-
| `kclipper ./benchmarks/10-charts-with-values.k` | 87.8 ± 3.5 | 84.0 | 126.6 | 1.91 ± 0.12 |
1+
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
2+
| :-------------------------------------- | ---------: | -------: | -------: | ----------: |
3+
| `kcl -V no-charts.k` | 57.7 ± 2.5 | 54.8 | 89.4 | 1.00 |
4+
| `kcl(ipper) -V no-charts.k` | 58.6 ± 2.1 | 55.8 | 82.0 | 1.02 ± 0.06 |
5+
| `kcl(ipper) -V 10-charts.k` | 91.2 ± 3.4 | 86.6 | 129.3 | 1.58 ± 0.09 |
6+
| `kcl(ipper) -V 10-charts-with-values.k` | 98.3 ± 4.3 | 93.6 | 146.1 | 1.71 ± 0.10 |

‎benchmarks/kcl.mod

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[package]
2+
name = "benchmarks"
3+
edition = "v0.11.0"
4+
version = "0.0.1"
5+
6+
[dependencies]
7+
helm = { path = "../modules/helm" }

‎benchmarks/kcl.mod.lock

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[dependencies]
2+
[dependencies.helm]
3+
name = "helm"
4+
full_name = "helm_0.0.1"
5+
version = "0.0.1"
6+
[dependencies.json_merge_patch]
7+
name = "json_merge_patch"
8+
full_name = "json_merge_patch_0.1.1"
9+
version = "0.1.1"
10+
sum = "o1aamShk1L2MGjnN9u3IErRZ3xBNDxgmFxXsGVMt8Wk="
11+
reg = "ghcr.io"
12+
repo = "kcl-lang/json_merge_patch"
13+
oci_tag = "0.1.1"
14+
[dependencies.k8s]
15+
name = "k8s"
16+
full_name = "k8s_1.31.2"
17+
version = "1.31.2"
18+
sum = "xBZgPsnpVVyWBpahuPQHReeRx28eUHGFoaPeqbct+vs="
19+
reg = "ghcr.io"
20+
repo = "kcl-lang/k8s"
21+
oci_tag = "1.31.2"

‎devbox.json

+1-5
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,13 @@
77
"go": "1.23.4",
88
"gofumpt": "latest",
99
"goimports": "latest",
10-
"zig": "0.10.1",
1110
"git": "latest",
1211
"nodePackages.prettier": "3.3",
1312
"kubernetes-helm": "3.16.3",
1413
"hyperfine": "1.19",
1514
"cobra-cli": "1.3.0",
1615
"graphviz": "12.2",
17-
"pprof": "2024-02-27"
18-
},
19-
"env": {
20-
"CGO_ENABLED": "1"
16+
"zig": "0.10"
2117
},
2218
"shell": {
2319
"init_hook": ["echo 'Welcome to devbox!' > /dev/null"]

0 commit comments

Comments
 (0)