https://github.com/workday/cuestomize
CUE-powered manifest generation in kustomize.
https://github.com/workday/cuestomize
cue cuelang k8s krm kubernetes kustomize kustomize-plugin package-manager
Last synced: 4 months ago
JSON representation
CUE-powered manifest generation in kustomize.
- Host: GitHub
- URL: https://github.com/workday/cuestomize
- Owner: Workday
- License: apache-2.0
- Created: 2025-07-31T20:14:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T16:04:51.000Z (5 months ago)
- Last Synced: 2026-01-27T04:14:32.884Z (5 months ago)
- Topics: cue, cuelang, k8s, krm, kubernetes, kustomize, kustomize-plugin, package-manager
- Language: Go
- Homepage: https://workday.github.io/cuestomize/
- Size: 1.34 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cuestomize
[](https://pkg.go.dev/github.com/workday/cuestomize)
Cuestomize is a Kubernetes Package Manager using CUE-lang and integrated in Kustomize.
It is implemented as a Kustomize KRM function that reads a CUE model, and optionally some input resources from the Kustomize stream, and passes back to Kustomize the generated resources.
It provides the type-safety of CUE and the flexibility of kustomize, combined in a single tool.
Moreover, it allows your CUE model to consume resources from the Kustomize stream, which can be used to feed the CUE model with input data (as well as the `input` section of the KRM function's specification).
The CUE model can then use the input values and resources to generate the output manifests.
The CUE model can either be pulled from an OCI registry, or be local to the KRM function (in which case you need to package a Docker image with both the CUE model and the Cuestomize binary).
## Usage
If you have a compatible CUE model already, you can use from kustomize as follows (look at the `example` directory for more information):
- Add it to the `transformers` section of your Kustomization file
```yaml
transformers:
- krm-func.yaml
```
- Then configure the KRM function in the `krm-func.yaml` file (or any name you gave to it)
```yaml
apiVersion: cuestomize.dev/v1alpha1 # or whatever apiVersion your CUE model expects
kind: Cuestomization # or whatever kind your CUE model expects
metadata:
name: my-cuestomization
annotations:
config.kubernetes.io/function: |
container:
image: ghcr.io/workday/cuestomize:latest
network: true
input:
replicas: 3
createRBAC: true
includes:
- kind: Namespace
name: my-namespace
```
Make sure to pass `kustomize build` the following flags:
- `--enable-alpha-plugins` to enable the KRM function
- `--network` if your CUE model is pulled from a registry.
> **Example:** `kustomize build . --enable-alpha-plugins --network`.
## CUE Model Integration
Cuestomize is able to integrate with any CUE model respecting the following constraints:
- The model accepts a `input` section (you are free to decide the structure of this section to match the expected KRM input structure)
- The model has an `outputs` section which is a slice of KRM resources. This field will hold the generated resources
- The model (optionally) accepts an `includes` section which is a map `::::{resource}` of resources that are forwarded from the kustomize input stream to the CUE model.