kapitan 0.35.2.dev15__tar.gz → 0.35.2.dev17__tar.gz

{kapitan-0.35.2.dev15 → kapitan-0.35.2.dev17}/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -65,8 +65,11 @@ body:
         Which version of kapitan are you running?
         If you are using an older version of kapitan, please try it against the master branch or the latest stable version.
       options:
-        - v0.31.0 (stable)
+        - v0.35.1 (latest)
+        - v0.35.0
+        - v0.34.x
         - master
+        - older
       multiple: true
     validations:
       required: true
@@ -76,7 +79,7 @@ body:
     attributes:
       label: Version (Python)
       description: |
-        Which version of Python are you using? Kapitan officially supports versions 3.10 - 3.13
+        Which version of Python are you using? Kapitan officially supports versions 3.10 - 3.13.
         If you are using an older version of python, please check if the bug still exists with a newer (supported) version.
       options:
         - "3.13"
@@ -87,6 +90,19 @@ body:
       multiple: true
     validations:
       required: true
+  # inventory backend
+  - type: dropdown
+    id: backend
+    attributes:
+      label: Inventory backend
+      description: Which inventory backend are you using?
+      options:
+        - reclass (default)
+        - reclass-rs
+        - omegaconf
+        - other / unknown
+    validations:
+      required: false
   # python virtual environment
   - type: checkboxes
     id: python-venv
@@ -102,8 +118,8 @@ body:
     id: os-information
     attributes:
       label: OS information
-      description: Which operation system do you use?
-      placeholder: Type in your operation system...
+      description: Which operating system do you use?
+      placeholder: e.g. Ubuntu 22.04, macOS 14, Fedora 40...
   # logs
   - type: textarea
     id: logs

{kapitan-0.35.2.dev15 → kapitan-0.35.2.dev17}/.github/ISSUE_TEMPLATE/documentation.yml

@@ -3,27 +3,37 @@ description: Give us feedback on the documentation
 title: "[docs]: "
 labels: ["documentation"]
 body:
-  # information
   - type: markdown
     attributes:
       value: |
         Thanks for taking the time to give us feedback!
-  # feature description
+  - type: input
+    id: page-url
+    attributes:
+      label: Page URL
+      description: Which page or section is affected?
+      placeholder: e.g. https://kapitan.dev/pages/core_concepts/
   - type: textarea
     id: documentation-issue-description
     attributes:
       label: Description of the documentation issue
       description: |
         A clear and concise description of what the issue with documentation is.
-        Please make proposals, how it could be done better.
+        Please make proposals for how it could be done better.
       placeholder: Tell us what you want to see in the project!
     validations:
       required: true
-  # additional context
+  - type: textarea
+    id: suggested-improvement
+    attributes:
+      label: Suggested improvement
+      description: |
+        If you have a specific suggestion (new wording, example, diagram, etc.), share it here.
+      placeholder: "It would be clearer if ..."
   - type: textarea
     id: additional-context
     attributes:
       label: Additional context
       description: |
-        Add any other context about the feature here.
-      placeholder: Anything that might help us understanding your documentation issue...
+        Add any other context about the documentation here.
+      placeholder: Anything that might help us understand your documentation request...

kapitan-0.35.2.dev17/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,43 @@
+name: Feature Request
+description: Request a new functionality
+title: "[feat]: "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Description of the feature
+      description: |
+        A clear and concise description of what the feature request is.
+        Please make proposals for how you would use this feature (syntax, CLI flags, inventory structure, etc.).
+      placeholder: Tell us what you want to see in the project!
+    validations:
+      required: true
+  - type: textarea
+    id: use-case
+    attributes:
+      label: Use case
+      description: |
+        Describe the problem or workflow that this feature would solve.
+        Concrete examples help us understand and prioritize.
+      placeholder: "When I try to ..., I have to work around by ..."
+    validations:
+      required: true
+  - type: checkboxes
+    id: contribute
+    attributes:
+      label: Contribution
+      description: Would you be willing to contribute this feature?
+      options:
+        - label: I would be willing to contribute this feature
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context about the feature here.
+      placeholder: Anything that might help us understand your feature request...

kapitan-0.35.2.dev17/.github/pull_request_template.md

@@ -0,0 +1,30 @@
+## Summary
+
+<!-- One or two sentences describing what this PR does. -->
+
+Fixes #
+
+## Motivation
+
+<!-- Why is this change needed? What problem does it solve? -->
+
+## Affected files or URLs
+
+<!-- List the key files, pages, or URLs changed. -->
+
+## Test plan
+
+<!-- Checklist of what you have tested or verified. -->
+- [ ] Tests added or updated
+- [ ] Documentation updated (if user-facing behavior changed)
+- [ ] `make lint` passes
+- [ ] `make format` passes (or no formatting changes needed)
+- [ ] Full test suite passes (`uv run pytest tests/ --no-cov`)
+
+## Risk assessment
+
+<!-- What could go wrong? How can it be reverted? -->
+
+## Follow-up work intentionally left out
+
+<!-- What is deliberately not included so the PR stays reviewable? -->

kapitan-0.35.2.dev17/CODE_OF_CONDUCT.md

@@ -0,0 +1,29 @@
+# Code of Conduct
+
+## Our standards
+
+We are committed to providing a friendly, safe, and welcoming environment for all contributors and users, regardless of experience level, background, or identity.
+
+Expected behavior:
+- Be respectful and constructive in all interactions.
+- Welcome newcomers and help them learn.
+- Accept constructive criticism gracefully.
+- Focus on what is best for the project and its community.
+
+Unacceptable behavior:
+- Harassment, discrimination, or intimidation of any kind.
+- Trolling, insulting/derogatory comments, or personal attacks.
+- Publishing others' private information without permission.
+- Other conduct that could reasonably be considered inappropriate in a professional setting.
+
+## Reporting issues
+
+If you experience or witness unacceptable behavior, please contact a maintainer listed in [MAINTAINERS.md](MAINTAINERS.md). All reports will be handled confidentially.
+
+## Scope
+
+This code of conduct applies within all project spaces (GitHub, Slack, events, mailing lists, etc.) and when representing the project in public.
+
+## Enforcement
+
+Maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that violate this code of conduct. Serious or repeated violations may result in a temporary or permanent ban from project spaces.

kapitan-0.35.2.dev17/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to Kapitan
+
+Thanks for your interest in contributing. This document covers bugs, features, documentation, and code contributions.
+
+## Quick orientation
+
+- **Questions** → [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3) on Kubernetes Slack or [GitHub Discussions](https://github.com/kapicorp/kapitan/discussions)
+- **Bug reports** → [Open an issue](https://github.com/kapicorp/kapitan/issues/new?template=bug_report.yml)
+- **Feature requests** → [Open an issue](https://github.com/kapicorp/kapitan/issues/new?template=feature_request.yml)
+- **Documentation fixes** → [Open an issue](https://github.com/kapicorp/kapitan/issues/new?template=documentation.yml) or send a PR directly
+- **Security issues** → See [SECURITY.md](SECURITY.md)
+
+## Development setup
+
+Kapitan uses **uv** for dependency management and **make** for task orchestration.
+
+```shell
+# Full setup (dependencies, external tools, pre-commit)
+make setup
+
+# Install only Python dependencies
+make install
+```
+
+## Running tests
+
+```shell
+# Run all tests with coverage
+uv run pytest -n auto
+
+# Run a specific test file
+uv run pytest tests/test_compile.py
+
+# Run a specific test class or method
+uv run pytest tests/test_class_wildcards.py::DiscoverClassesTest::test_discovers_yml_and_yaml
+
+# Skip slow tests
+uv run pytest -m "not slow"
+```
+
+Before declaring a feature or fix done, run both the focused subset **and** the full suite:
+
+```shell
+uv run pytest tests/ --no-cov
+```
+
+## Code style
+
+We use **Ruff** for linting and formatting. Target Python version is 3.10. Line length is 88.
+
+```shell
+# Check and auto-fix
+make fix
+make fix-tests
+
+# Verify formatting
+make check_format
+```
+
+Pre-commit hooks run on commit. If a hook fails, fix the issue and commit again.
+
+## Submitting a pull request
+
+1. Branch from `master`.
+2. Make focused, reviewable changes.
+3. Add or update tests for code changes.
+4. Update documentation if user-facing behavior changes.
+5. Ensure `make format` and `make lint` pass.
+6. Open a PR using the provided template.
+
+## What we value
+
+- Accuracy over marketing: do not exaggerate capabilities.
+- Concrete examples over generic descriptions.
+- Small, reviewable PRs over monolithic changes.
+- Tests that hit real behavior over mocks where possible.
+
+## Maintainers
+
+Current maintainers are listed in [MAINTAINERS.md](MAINTAINERS.md).

kapitan-0.35.2.dev17/MAINTAINERS.md

@@ -0,0 +1,32 @@
+# Maintainers
+
+This file lists the people who currently maintain Kapitan.
+
+## Core maintainers
+
+| GitHub handle | Name | Focus |
+|---------------|------|-------|
+| [@ramaro](https://github.com/ramaro) | Ricardo Amaro | Project lead, reviews, releases |
+| [@ademariag](https://github.com/ademariag) | Alessandro De Maria | Architecture, features, community |
+| [@uberspot](https://github.com/uberspot) | — | Code, features |
+| [@adrianchifor](https://github.com/adrianchifor) | Adrian Chifor | Features, infrastructure |
+| [@Moep90](https://github.com/Moep90) | Danny H. | Documentation, testing, backends |
+| [@gburiola](https://github.com/gburiola) | Luis Buriola | Features, integrations |
+
+## Bots and automation
+
+| GitHub handle | Purpose |
+|---------------|---------|
+| [@kapicorpbot](https://github.com/kapicorpbot) | CI and release automation |
+| [@KapitanCi](https://github.com/KapitanCi) | Continuous integration |
+
+## How to become a maintainer
+
+There is no formal process. Consistent, high-quality contributions over time are the main path. Existing maintainers nominate and vote privately. If you are interested, keep contributing, help review others' PRs, and engage respectfully in discussions.
+
+## Maintainer responsibilities
+
+- Triage issues and pull requests in a timely manner.
+- Keep the codebase healthy: tests pass, dependencies up to date, security patches applied.
+- Release new versions with clear release notes.
+- Enforce the [Code of Conduct](CODE_OF_CONDUCT.md).

{kapitan-0.35.2.dev15 → kapitan-0.35.2.dev17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kapitan
-Version: 0.35.2.dev15
+Version: 0.35.2.dev17
 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.dev17/SECURITY.md

@@ -0,0 +1,37 @@
+# Security Policy
+
+## Supported versions
+
+We release security fixes for the latest stable version and the `master` branch. If you are running an older version, upgrading is the fastest path to a fix.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| Latest stable | :white_check_mark: |
+| master  | :white_check_mark: |
+| Older releases | :x:                |
+
+## Reporting a vulnerability
+
+Please do **not** open a public issue for security problems.
+
+Instead, use one of these channels:
+
+1. **GitHub Private Security Advisory** — [Open a draft advisory](https://github.com/kapicorp/kapitan/security/advisories/new) (preferred).
+2. **Contact a maintainer directly** — See [MAINTAINERS.md](MAINTAINERS.md) for current maintainers.
+
+Include as much detail as possible:
+- Affected versions
+- Steps to reproduce
+- Potential impact
+- Suggested fix (if you have one)
+
+## Response process
+
+- We aim to acknowledge reports within 5 business days.
+- We will investigate and provide an initial assessment within 15 business days.
+- Once a fix is ready, we will coordinate disclosure and publish a security advisory.
+- We credit reporters unless they prefer to remain anonymous.
+
+## Disclosure policy
+
+We follow a coordinated disclosure model. We ask reporters to give us reasonable time to release a fix before publicly discussing the issue.

kapitan-0.35.2.dev17/SUPPORT.md

@@ -0,0 +1,26 @@
+# Getting Support
+
+## Community chat
+
+The best place for quick questions and informal discussion is the [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3) channel on Kubernetes Slack. [Get an invite](https://slack.k8s.io/) if you are not already on the workspace.
+
+## Documentation
+
+- [Getting Started](https://kapitan.dev/getting_started/)
+- [Core Concepts](https://kapitan.dev/pages/core_concepts/)
+- [FAQ](https://kapitan.dev/FAQ/)
+- [Kapitan Reference repository](https://github.com/kapicorp/kapitan-reference) — working examples
+
+## GitHub
+
+- **Issues** — [Bug reports and feature requests](https://github.com/kapicorp/kapitan/issues)
+- **Discussions** — [Q&A and general conversation](https://github.com/kapicorp/kapitan/discussions)
+- **Pull Requests** — [Contribute code or documentation](https://github.com/kapicorp/kapitan/pulls)
+
+## Security
+
+For security-related issues, see [SECURITY.md](SECURITY.md) instead of opening a public issue.
+
+## Sponsorship
+
+If your organization benefits from Kapitan, consider [sponsoring the project](https://github.com/sponsors/kapicorp) to help fund ongoing maintenance and development.

kapitan-0.35.2.dev17/docs/pages/argocd.md

@@ -0,0 +1,93 @@
+# :kapitan-logo: ArgoCD Integration
+
+Kapitan can be used as an [ArgoCD Config Management Plugin (CMP)](https://argo-cd.readthedocs.io/en/stable/operator-manual/config-management-plugins/).
+
+## Prerequisites
+
+- ArgoCD v2.8+
+- The `kapicorp/kapitan` image accessible from your cluster
+
+## Setup
+
+Add a Kapitan sidecar to the ArgoCD repo-server. The sidecar must:
+
+- Run the `kapicorp/kapitan` image
+- Start with `/var/run/argocd/argocd-cmp-server` (copied from the ArgoCD image via an init container)
+- Mount a CMP plugin config that defines a `generate` command for Kapitan
+
+### CMP plugin config
+
+The `generate` command should produce Kubernetes manifests from your compiled output. A typical script concatenates the generated YAML files and runs `kapitan refs --reveal` to decrypt secrets:
+
+```bash
+rm -rf all_manifests.yml
+for f in *.yml; do
+  echo '---' >> all_manifests.yml
+  cat "$f" >> all_manifests.yml
+done
+kapitan refs --reveal --file all_manifests.yml
+```
+
+A minimal Helm values snippet:
+
+```yaml
+configs:
+  cmp:
+    plugins:
+      kapitan:
+        generate:
+          command: [bash, -c]
+          args:
+            - |
+              rm -rf all_manifests.yml
+              for f in *.yml; do
+                echo '---' >> all_manifests.yml
+                cat "$f" >> all_manifests.yml
+              done
+              kapitan refs --reveal --file all_manifests.yml
+
+repoServer:
+  extraContainers:
+    - name: kapitan
+      image: kapicorp/kapitan
+      command: [/var/run/argocd/argocd-cmp-server]
+      volumeMounts:
+        - mountPath: /var/run/argocd
+          name: var-files
+        - mountPath: /home/argocd/cmp-server/plugins
+          name: plugins
+        - mountPath: /home/argocd/cmp-server/config/plugin.yaml
+          name: cmp-plugin
+          subPath: plugin.yaml
+```
+
+See the [ArgoCD CMP documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/config-management-plugins/) for the full sidecar wiring.
+
+## Application
+
+Create an ArgoCD Application that uses the plugin:
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: my-kapitan-app
+  namespace: argocd
+spec:
+  project: default
+  source:
+    repoURL: https://github.com/example/kapitan-project.git
+    targetRevision: main
+    path: compiled/my-target
+    plugin:
+      name: kapitan
+  destination:
+    server: https://kubernetes.default.svc
+    namespace: default
+  syncPolicy:
+    automated:
+      prune: true
+      selfHeal: true
+```
+
+Update `spec.source.repoURL` and `spec.source.path` to match your repository and compiled target output.

kapitan-0.35.2.dev17/docs/pages/fluxcd.md

@@ -0,0 +1,63 @@
+# :kapitan-logo: FluxCD Integration
+
+Kapitan works with [FluxCD](https://fluxcd.io) by compiling manifests in CI and publishing them as [OCI artifacts](https://fluxcd.io/flux/cheatsheets/oci-artifacts/). FluxCD pulls the artifact and applies it to the cluster.
+
+## Prerequisites
+
+- FluxCD v2.0+
+- `flux` CLI installed in your CI pipeline
+
+## Workflow
+
+1. CI runs `kapitan compile`
+2. CI pushes the `compiled/` directory as an OCI artifact
+3. FluxCD pulls the artifact and applies it
+
+## CI
+
+Push the compiled output with the `flux` CLI:
+
+```shell
+kapitan compile
+flux push artifact oci://ghcr.io/org/app-manifests:$(git rev-parse --short HEAD) \
+  --path="./compiled" \
+  --source="$(git config --get remote.origin.url)" \
+  --revision="$(git branch --show-current)@sha1:$(git rev-parse HEAD)"
+```
+
+## FluxCD Resources
+
+Pull the artifact:
+
+```yaml
+apiVersion: source.toolkit.fluxcd.io/v1
+kind: OCIRepository
+metadata:
+  name: app-manifests
+  namespace: flux-system
+spec:
+  interval: 5m
+  url: oci://ghcr.io/org/app-manifests
+  ref:
+    tag: latest
+```
+
+Apply it:
+
+```yaml
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
+metadata:
+  name: app
+  namespace: flux-system
+spec:
+  interval: 10m
+  sourceRef:
+    kind: OCIRepository
+    name: app-manifests
+  path: ./
+  prune: true
+  wait: true
+```
+
+See the [FluxCD OCI cheatsheet](https://fluxcd.io/flux/cheatsheets/oci-artifacts/) for tagging strategies, cosign signing, and verification.

{kapitan-0.35.2.dev15 → kapitan-0.35.2.dev17}/mkdocs.yml

@@ -104,6 +104,8 @@ nav:
         - Remote repositories: pages/remote_repositories.md
         - External dependencies: pages/external_dependencies.md
         - Publishing generators: pages/publishing_generators.md
+        - ArgoCD integration: pages/argocd.md
+        - FluxCD integration: pages/fluxcd.md
       - CLI reference:
           - compile: pages/commands/kapitan_compile.md
           - inventory: pages/commands/kapitan_inventory.md

kapitan-0.35.2.dev15/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,29 +0,0 @@
-name: Feature Request
-description: Request a new functionality
-title: "[feat]: "
-labels: ["feature"]
-body:
-  # information
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this feature request!
-  # feature description
-  - type: textarea
-    id: feature-description
-    attributes:
-      label: Description of the feature
-      description: |
-        A clear and concise description of what the feature request is.
-        Please make proposals, how you would use this feature (syntax).
-      placeholder: Tell us what you want to see in the project!
-    validations:
-      required: true
-  # additional context
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional context
-      description: |
-        Add any other context about the feature here.
-      placeholder: Anything that might help us understanding your feature request...

kapitan-0.35.2.dev15/.github/pull_request_template.md

@@ -1,10 +0,0 @@
-Fixes #
-
-## Proposed Changes
-
-*
-
-## Docs and Tests
-
-* [ ] Tests added
-* [ ] Updated documentation