kapitan 0.35.2.dev9__tar.gz → 0.35.2.dev11__tar.gz

kapitan-0.35.2.dev11/.github/filters/filters.yml

@@ -0,0 +1,16 @@
+# ------------------------------------------------
+# Path filters for test-build-publish.yml
+# ------------------------------------------------
+
+docs:
+  - 'docs/**'
+  - '.github/workflows/documentation.yml'
+  - 'mkdocs.yml'
+  - 'CNAME'
+
+code:
+  - '**'
+  - '!docs/**'
+  - '!mkdocs.yml'
+  - '!CNAME'
+  - '!.github/workflows/documentation.yml'

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/.github/workflows/test-build-publish.yml

@@ -20,21 +20,11 @@ on:
       - master
       - main
       - test/*
-    paths-ignore:
-      - 'docs/**'
-      - '.github/workflows/documentation.yml'
-      - 'mkdocs.yml'
-      - 'CNAME'
 
   release:
     types: [created]
 
   pull_request:
-    paths-ignore:
-      - 'docs/**'
-      - '.github/workflows/documentation.yml'
-      - 'mkdocs.yml'
-      - 'CNAME'
 
 jobs:
   setup:
@@ -66,18 +56,37 @@ jobs:
             echo 'EOF'
           } >> "$GITHUB_OUTPUT"
 
+  check-changes:
+    name: detect code changes
+    runs-on: ubuntu-24.04
+    outputs:
+      has-docs-changes: ${{ steps.filter.outputs.docs }}
+      has-code-changes: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+          filter: blob:none
+      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
+        id: filter
+        with:
+          predicate-quantifier: 'every'
+          filters: .github/filters/filters.yml
   precommit:
     name: precommit checks
-    needs: [setup]
+    needs: [setup, check-changes]
     runs-on: ${{ needs.setup.outputs.runner }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        if: needs.check-changes.outputs.has-code-changes == 'true'
       - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        if: needs.check-changes.outputs.has-code-changes == 'true'
       - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+        if: needs.check-changes.outputs.has-code-changes == 'true'
 
   test:
     name: python ${{ matrix.python-version }} tests
-    needs: [setup]
+    needs: [setup, check-changes]
     runs-on: ${{ needs.setup.outputs.runner }}
     strategy:
       fail-fast: false
@@ -85,21 +94,26 @@ jobs:
         python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
     steps:
       - name: Checkout kapitan recursively
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           submodules: recursive
       - name: Set up Python ${{ matrix.python-version }}
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Set up uv
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
       - name: Install libraries dependencies
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         run: |
           uv sync --locked --all-extras --dev
 
       - name: Cache external tools
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         id: cache-tools
         uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4
         with:
@@ -110,7 +124,7 @@ jobs:
           key: external-tools-${{ runner.os }}-${{ runner.arch }}-v1
 
       - name: Install external tools
-        if: steps.cache-tools.outputs.cache-hit != 'true'
+        if: needs.check-changes.outputs.has-code-changes == 'true' && steps.cache-tools.outputs.cache-hit != 'true'
         run: |
           # Install Helm
           curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
@@ -125,12 +139,14 @@ jobs:
           curl -fsSL "https://github.com/cue-lang/cue/releases/download/${CUE_VERSION}/cue_${CUE_VERSION}_linux_${ARCH}.tar.gz" | sudo tar xz -C /usr/local/bin cue
 
       - name: Verify external tools
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         run: |
           helm version --short
           kustomize version
           cue version
 
       - name: Run pytest
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: pavelzw/pytest-action@510c5e90c360a185039bea56ce8b3e7e51a16507 # v2.2.0
         with:
           verbose: true
@@ -143,7 +159,7 @@ jobs:
 
   build:
     name: build ${{ matrix.platform.platform }} image using python ${{ matrix.python-version }}
-    needs: [setup, precommit, test]
+    needs: [setup, precommit, test, check-changes]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       fail-fast: false
@@ -152,23 +168,26 @@ jobs:
         python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
     steps:
       - name: Checkout kapitan recursively
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           submodules: recursive
 
       - name: Set up Docker Buildx
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
 
       - name: Login to DockerHub
         uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
         env:
           DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-        if: env.DOCKERHUB_USERNAME != '' && github.event_name != 'pull_request'
+        if: needs.check-changes.outputs.has-code-changes == 'true' && env.DOCKERHUB_USERNAME != '' && github.event_name != 'pull_request'
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Compute tag suffix
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         id: suffix
         run: |
           # Platform suffix: convert linux/amd64 -> -linux-amd64
@@ -185,6 +204,7 @@ jobs:
           fi
 
       - name: Docker meta
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         id: meta
         uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6.0.0
         with:
@@ -202,7 +222,7 @@ jobs:
       # For default python version, also create tags with -py suffix for compatibility
       - name: Docker meta (py-suffixed tags for default version)
         id: meta-py
-        if: steps.suffix.outputs.is-default == 'true'
+        if: needs.check-changes.outputs.has-code-changes == 'true' && steps.suffix.outputs.is-default == 'true'
         uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6.0.0
         with:
           images: |
@@ -216,6 +236,7 @@ jobs:
             latest=false
 
       - name: Combine tags
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         id: tags
         run: |
           # Combine primary tags with py-suffixed tags (if any)
@@ -228,6 +249,7 @@ jobs:
 
       # Build, test locally, then push if not a PR
       - name: Build Kapitan image
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
           platforms: ${{ matrix.platform.platform }}
@@ -241,13 +263,14 @@ jobs:
             PYTHON_VERSION=${{ matrix.python-version }}
 
       - name: Test Kapitan image
+        if: needs.check-changes.outputs.has-code-changes == 'true'
         run: |
           docker run -t --rm local-test --version
 
       - name: Push image to DockerHub
         env:
           DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-        if: env.DOCKERHUB_USERNAME != '' && github.event_name != 'pull_request'
+        if: needs.check-changes.outputs.has-code-changes == 'true' && env.DOCKERHUB_USERNAME != '' && github.event_name != 'pull_request'
         uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
           platforms: ${{ matrix.platform.platform }}
@@ -263,7 +286,8 @@ jobs:
     needs:
       - setup
       - build
-    if: github.event_name != 'pull_request'
+      - check-changes
+    if: github.event_name != 'pull_request' && needs.check-changes.outputs.has-code-changes == 'true'
     runs-on: ${{ needs.setup.outputs.runner }}
     timeout-minutes: 10
     strategy:

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kapitan
-Version: 0.35.2.dev9
+Version: 0.35.2.dev11
 Summary: Generic templated configuration management for Kubernetes, Terraform and other things
 Project-URL: Homepage, https://kapitan.dev
 Project-URL: Repository, https://github.com/kapicorp/kapitan

kapitan-0.35.2.dev11/docs/FAQ.md

@@ -0,0 +1,66 @@
+---
+comments: true
+title: "Kapitan FAQ: Common Questions About Inventory, Compile, and Secrets"
+description: "Find answers to frequently asked questions about Kapitan inventory, targets, classes, compilation, references, secrets, and supported input types."
+---
+
+# :kapitan-logo: **Kapitan FAQ**
+
+## Why do I need Kapitan?
+
+See the blog post [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan) for a detailed explanation of the problems Kapitan solves, including configuration sprawl, duplication across environments, and secrets management.
+
+## What is the Kapitan inventory?
+
+The [inventory](pages/inventory/introduction.md) is a hierarchical YAML structure that captures all the data you want to make available to Kapitan's templating engines. It is divided into [targets](pages/inventory/targets.md) (environments or deployments) and [classes](pages/inventory/classes.md) (reusable configuration fragments). Learn more in the [inventory introduction](pages/inventory/introduction.md).
+
+## How do I install Kapitan?
+
+The easiest way is via Docker:
+
+```shell
+docker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan -h
+```
+
+Or install with pip:
+
+```shell
+pip3 install --user --upgrade kapitan
+```
+
+See the [Getting Started](getting_started.md) page for full installation instructions.
+
+## Which input type should I use?
+
+It depends on your use case:
+
+- **[Jsonnet](pages/input_types/jsonnet.md)** — structured data, Kubernetes manifests, JSON Schema validation
+- **[Jinja](pages/input_types/jinja.md)** — scripts, documentation, text templates
+- **[Kadet](pages/input_types/kadet.md)** — Python-based generation, reusable libraries
+- **[Helm](pages/input_types/helm.md)** — rendering existing Helm charts
+- **[Kustomize](pages/input_types/kustomize.md)** — patching Kubernetes manifests
+- **[CUE](pages/input_types/cuelang.md)** — typed configuration with validation
+
+## How does Kapitan manage secrets?
+
+Kapitan uses [References](references.md) (formerly Secrets) to manage sensitive and dynamic values. Supported backends include GPG, AWS KMS, GCP KMS, Azure Key Vault, HashiCorp Vault, and plain/base64 for non-sensitive data. See the [References documentation](references.md) for setup instructions.
+
+## What is parameter interpolation?
+
+Parameter interpolation lets you reference values defined elsewhere in the inventory using the `${variable:name}` syntax. This reduces duplication and makes configuration more maintainable. Read the [parameter interpolation guide](pages/inventory/parameters_interpolation.md) for details.
+
+## How do I compile a target?
+
+```shell
+kapitan compile -t <target_name>
+```
+
+Without a target flag, Kapitan compiles all discovered targets. See the [`kapitan compile` CLI reference](pages/commands/kapitan_compile.md) for all options.
+
+## Where can I find examples?
+
+The [kapicorp/kapitan-reference](https://github.com/kapicorp/kapitan-reference) repository contains working examples for Kubernetes, Terraform, and more. You can also explore the [input type documentation](pages/input_types/introduction.md) for small, focused examples.
+
+## Ask your question
+
+Please use the comments facility below to ask your question.

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/getting_started.md

@@ -171,3 +171,12 @@ Every merge to `master` is automatically published to PyPI as a PEP 440 pre-rele
     ```shell
     poetry add --allow-prereleases kapitan
     ```
+
+---
+
+## Next steps
+
+- Learn the [Kapitan core concepts](pages/core_concepts.md): how inventory, targets, classes, and input types work together.
+- Understand the [Kapitan inventory](pages/inventory/introduction.md): targets, classes, and parameter interpolation.
+- Explore [input types](pages/input_types/introduction.md) such as [Jsonnet](pages/input_types/jsonnet.md), [Jinja](pages/input_types/jinja.md), [Kadet](pages/input_types/kadet.md), [Helm](pages/input_types/helm.md), and [Kustomize](pages/input_types/kustomize.md).
+- Manage secrets and external values with [Kapitan References](references.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/core_concepts.md

@@ -161,3 +161,11 @@ parameters:
     headquarters: London
     timezone: Europe/London
 ```
+
+---
+
+## Next steps
+
+- Dive deeper into the [Kapitan inventory](inventory/introduction.md): how [targets](inventory/targets.md), [classes](inventory/classes.md), and [parameter interpolation](inventory/parameters_interpolation.md) model your configuration.
+- Choose an [input type](input_types/introduction.md) for your use case: [Jsonnet](input_types/jsonnet.md), [Jinja](input_types/jinja.md), [Kadet](input_types/kadet.md), [Helm](input_types/helm.md), [Kustomize](input_types/kustomize.md), or [CUE](input_types/cuelang.md).
+- Learn how to manage secrets and dynamic values with [Kapitan References](../references.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/input_types/introduction.md

@@ -156,3 +156,17 @@ Input types can be specified in the inventory under `kapitan.compile` in the fol
     ```
 
     1. (Default: global --prune)
+
+---
+
+## Next steps
+
+- Learn how the [Kapitan inventory](../inventory/introduction.md) feeds data into every input type.
+- Choose the right template engine for your use case:
+  - [Jsonnet](jsonnet.md) for structured data and Kubernetes manifests
+  - [Jinja](jinja.md) for scripts and documentation
+  - [Kadet](kadet.md) for Python-based generation
+  - [Helm](helm.md) for existing Helm charts
+  - [Kustomize](kustomize.md) for Kubernetes manifest patches
+  - [CUE](cuelang.md) for typed configuration validation
+- Manage secrets and external values with [Kapitan References](../../references.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/input_types/jsonnet.md

@@ -138,3 +138,12 @@ If `validation.valid` is not true, it will then fail compilation and display `va
 
     Compile error: failed to compile target: minikube-mysql
     ```
+
+---
+
+## Next steps
+
+- Learn how the [Kapitan inventory](../inventory/introduction.md) makes data available to Jsonnet templates.
+- Explore other [input types](introduction.md) such as [Jinja](jinja.md), [Kadet](kadet.md), and [Helm](helm.md).
+- Validate your generated output with [`kapitan validate`](../commands/kapitan_validate.md).
+- Manage secrets in Jsonnet templates with [Kapitan References](../../references.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/inventory/advanced.md

@@ -40,3 +40,11 @@ For instance you could define the following:
         Compiled acme (0.06s)
         Compiled acme-documentation (0.09s)
         ```
+
+---
+
+## Next steps
+
+- Review the [inventory introduction](introduction.md) for a refresher on targets and classes.
+- Learn about [inventory backends](backends.md) such as reclass-rs and OmegaConf.
+- Explore the [`kapitan compile` CLI reference](../commands/kapitan_compile.md#using-labels) for more label options.

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/inventory/classes.md

@@ -56,4 +56,13 @@ If we open the file, we find another familiar yaml fragment.
 
 Notice that this class includes an import definition for another class, `kapitan.common`. We've already learned this means that kapitan will import a file on disk called `inventory/classes/kapitan/common.yml`
 
-You can also see that in the `parameters` section we now encounter a new syntax which unlocks another powerful inventory feature: *parameters interpolation*!
+You can also see that in the `parameters` section we now encounter a new syntax which unlocks another powerful inventory feature: [parameter interpolation](parameters_interpolation.md)!
+
+---
+
+## Next steps
+
+- Learn how to define environments and deployments with [Kapitan inventory targets](targets.md).
+- Understand how to reference values across classes and targets with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as wildcard classes and inventory backends.
+- See how classes power [input types](../input_types/introduction.md) like [Jsonnet](../input_types/jsonnet.md) and [Jinja](../input_types/jinja.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/inventory/introduction.md

@@ -71,3 +71,13 @@ parameters:
 
 
 By combining [**target**](targets.md) and [**classes**](classes.md), the **Inventory** becomes the SSOT for your whole configuration, and learning how to use it will unleash the real power of **Kapitan**.
+
+---
+
+## Next steps
+
+- Learn how to define environments and deployments with [Kapitan inventory targets](targets.md).
+- Understand how to compose reusable configuration with [Kapitan inventory classes](classes.md).
+- Discover how to reference values across the inventory with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as target labels and inventory backends.
+- See how the inventory drives [input types](../input_types/introduction.md) like [Jsonnet](../input_types/jsonnet.md), [Jinja](../input_types/jinja.md), and [Helm](../input_types/helm.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/inventory/parameters_interpolation.md

@@ -68,4 +68,13 @@ classes:
 
 Here in this case `application.location` refers to a value `location` which has been defined elsewhere, perhaps (but not necessarily) in the `project.production` class.
 
-Also notice that the class name (`project.production`) is not in any ways influencing the name or the structed of the yaml it imports into the file
+Also notice that the class name (`project.production`) is not in any ways influencing the name or the structed of the yaml it imports into the file.
+
+---
+
+## Next steps
+
+- Review the [Kapitan inventory introduction](introduction.md) to understand how targets and classes form the configuration hierarchy.
+- Learn how to define environments with [Kapitan inventory targets](targets.md).
+- Compose reusable fragments with [Kapitan inventory classes](classes.md).
+- Explore [advanced inventory features](advanced.md) such as inventory backends and wildcard classes.

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/pages/inventory/targets.md

@@ -76,3 +76,12 @@ inventory/
 ```
 
 In this example, the `my-cluster.yml` target file is located within the `clusters/production/` subdirectory, and can be identified with `clusters.production.my-cluster`.
+
+---
+
+## Next steps
+
+- Compose reusable configuration fragments with [Kapitan inventory classes](classes.md).
+- Learn how to reference values across classes and targets with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as target labels.
+- See how targets are compiled with different [input types](../input_types/introduction.md).

{kapitan-0.35.2.dev9 → kapitan-0.35.2.dev11}/docs/references.md

@@ -796,3 +796,11 @@ For example, to reveal the secret stored at `path/to/secret_inside_kapitan`
     ```
 
 *Note:* Cryptographic algorithm used for encryption is *rsa-oaep-256*.
+
+---
+
+## Next steps
+
+- Learn how to model your configuration with the [Kapitan inventory](pages/inventory/introduction.md).
+- See how references are used during [compilation](pages/input_types/introduction.md).
+- Explore the [`kapitan compile`](pages/commands/kapitan_compile.md) and [`kapitan refs`](pages/commands/kapitan_inventory.md) CLI commands.

kapitan-0.35.2.dev9/docs/FAQ.md

@@ -1,15 +0,0 @@
----
-comments: true
-title: "Kapitan FAQ: Common Questions About Inventory, Compile, and Secrets"
-description: "Find answers to frequently asked questions about Kapitan inventory, targets, classes, compilation, references, secrets, and supported input types."
----
-
-# :kapitan-logo: **Kapitan FAQ**
-
-## Why do I need **Kapitan**?
-
-See [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan)
-
-## Ask your question
-
-Please use the comments facility below to ask your question