kapitan 0.35.2.dev30__tar.gz → 0.35.2.dev32__tar.gz

{kapitan-0.35.2.dev30 → kapitan-0.35.2.dev32}/.github/workflows/test-build-publish.yml

@@ -150,7 +150,9 @@ jobs:
           verbose: true
           emoji: false
           job-summary: true
-          custom-pytest: mise exec -- uv run pytest -n auto
+          # pytest-xdist has known hangs/crashes on Python 3.14 (issue #1289/#1313);
+          # run serially on 3.14 until upstream fix is available.
+          custom-pytest: ${{ matrix.python-version == '3.14' && 'mise exec -- uv run pytest' || 'mise exec -- uv run pytest -n auto' }}
           custom-arguments: '-q'
           click-to-expand: true
           report-title: 'Kapitan tests'

{kapitan-0.35.2.dev30 → kapitan-0.35.2.dev32}/Makefile

@@ -109,6 +109,13 @@ test_coverage: test_python
 	@echo "===== Running Coverage Report ====="
 	$(UV_RUN) coverage report
 
+# Regenerate golden compiled snapshots for inventory backend examples
+.PHONY: refresh-inventory-backend-goldens
+refresh-inventory-backend-goldens:
+	@echo "===== Refreshing Inventory Backend Example Golden Snapshots ====="
+	uv run python scripts/refresh_inventory_backend_goldens.py
+	@echo "Golden snapshots refreshed. Review git diff before committing."
+
 # Build Docker image
 .PHONY: build_docker
 build_docker:

{kapitan-0.35.2.dev30 → kapitan-0.35.2.dev32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kapitan
-Version: 0.35.2.dev30
+Version: 0.35.2.dev32
 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.dev32/examples/omegaconf/inventory/classes/common.yml

@@ -0,0 +1,13 @@
+---
+parameters:
+  target_name: ${_kapitan_.name.short}
+
+  app_name: omegaconf-test
+  environment: dev
+  namespace: default
+  cluster: minikube
+  replicas: 1
+
+  kapitan:
+    vars:
+      target: ${target_name}

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/deferred.yml

@@ -0,0 +1,38 @@
+---
+parameters:
+  # Deferred parentkey resolver demonstration
+  # parentkey resolves at definition location, not merge destination
+  deployment_template:
+    name: \${parentkey:}
+    namespace: ${namespace}
+    labels:
+      app.kubernetes.io/name: \${parentkey:}
+      app.kubernetes.io/instance: ${target_name}
+
+  deployments:
+    web-app: ${merge:${deployment_template}, ${web_app_overrides}}
+    api-service: ${merge:${deployment_template}, ${api_service_overrides}}
+
+  web_app_overrides:
+    replicas: 2
+
+  api_service_overrides:
+    replicas: 3
+
+  # Custom resolver with _root_ context access
+  secrets:
+    db_password: ${with_root:database,password}
+
+  # Uppercase custom resolver
+  uppercase_test:
+    env_upper: ${upper:${environment}}
+    cluster_upper: ${upper:${cluster}}
+
+  # Capitalize custom resolver (camelCase)
+  capitalize_test:
+    camel_name: ${capitalize:${app_name}}
+
+  # String extraction custom resolvers
+  demo_name: omegaconf-demo
+  suffix_test: ${get_suffix:${demo_name}}
+  substr_test: ${get_substr:${demo_name}}

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/empty.yml

@@ -0,0 +1,6 @@
+---
+# Intentionally empty class to test null/empty handling
+classes:
+parameters:
+  empty_test:
+    loaded: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/functions.yml

@@ -0,0 +1,60 @@
+---
+parameters:
+  # Test list resolver: convert dict to list of single-key dicts
+  list_input:
+    item1: first
+    item2: second
+  list_result: ${list:${list_input}}
+
+  # Test yaml resolver: dump nested structure to YAML string
+  yaml_source:
+    level1:
+      level2: nested_value
+  yaml_result: ${yaml:yaml_source}
+
+  # Test default resolver: provide fallback when key is missing
+  default_result: ${default:missing_key,fallback_value}
+
+  # Test access resolver: access a key with dots in the name
+  "dotted.key": accessed_value
+  access_result: ${access:dotted.key}
+
+  # Test boolean algebra resolvers
+  bool_and: ${and:true,true,false}
+  bool_or: ${or:false,true,false}
+  bool_not: ${not:true}
+  bool_equal: ${equal:${environment},dev}
+
+  # Test fullkey and key resolvers (evaluated in nested context)
+  key_test:
+    full_name: ${fullkey:}
+    simple_name: ${key:}
+
+  # Test write resolver: write resolved content to another location
+  write_source:
+    copied: true
+    nested:
+      value: written_value
+  write_result: ${write:written_target,write_source}
+
+  # After write, this should be populated
+  written_target:
+    placeholder: before_write
+
+  # Test nested function composition
+  nested_func: ${upper:${concat:hello,world}}
+
+  # Test parentkey in non-deferred context
+  parentkey_test:
+    name: ${parentkey:}
+
+  # Test if with non-string condition
+  if_numeric: ${if:${replicas},has_replicas}
+
+  # Test dict-like merge result behavior
+  dict_merge_result:
+    a: 1
+    b: 2
+
+  kapitan:
+    compile: []

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/init/init.yml

@@ -0,0 +1,5 @@
+---
+# Omegaconf init class: loaded automatically when the parent directory is included
+parameters:
+  init_value: from_init
+  init_common: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/init.yml

@@ -0,0 +1,8 @@
+---
+# This class demonstrates the init class feature.
+# When 'features.init' is included, omegaconf loads features/init/init.yml
+classes:
+  - features.init
+
+parameters:
+  init_child: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/interpolation.yml

@@ -0,0 +1,34 @@
+---
+parameters:
+  # Standard dot-notation interpolation
+  interpolated: ${app_name}
+
+  # Nested interpolation (interpolation inside interpolation)
+  nested_key: environment
+  nested_interpolated: ${${nested_key}}
+
+  # Escaped interpolation using backslash (deferred - resolved in second pass)
+  deferred_value: \${app_name}
+
+  # Escaped interpolation using escape resolver (preserved as literal string)
+  escaped_value: ${escape:app_name}
+
+  # Interpolation used in string composition
+  full_name: ${app_name}-${environment}
+
+  # Reference to another parameter path
+  ref_value: ${namespace}
+
+  # Conditional with false condition (should produce empty dict)
+  feature_disabled: false
+  conditional_false: ${if:${feature_disabled},should_not_appear}
+
+  # Escape must not resolve even when content matches a real key
+  escaped_real_key: ${escape:environment}
+
+  # Relative path resolver with nested structures
+  nested_config:
+    database:
+      host: db.${cluster}.local
+      port: 5432
+    connection_string: postgresql://${relpath:nested_config.database.host}:${relpath:nested_config.database.port}/mydb

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/merge.yml

@@ -0,0 +1,63 @@
+---
+parameters:
+  # Base objects for merge demonstration
+  base_service:
+    type: ClusterIP
+    port: 80
+    protocol: TCP
+    labels:
+      managed-by: kapitan
+
+  service_override:
+    port: 8080
+    target_port: 8080
+
+  # Merge resolver usage
+  merged_service: ${merge:${base_service}, ${service_override}}
+
+  # Deep merge demonstration
+  base_config:
+    level1:
+      key_a: value_a
+      key_b: value_b
+
+  config_override:
+    level1:
+      key_b: overridden_b
+      key_c: value_c
+
+  merged_config: ${merge:${base_config}, ${config_override}}
+
+  # List concatenation in merge
+  base_list:
+    items:
+      - item1
+      - item2
+
+  list_override:
+    items:
+      - item3
+      - item4
+
+  merged_list: ${merge:${base_list}, ${list_override}}
+
+  # Three-way merge demonstration (replaces the old test_three_way_merge case):
+  # combine defaults + a scalar override + an annotation-style nested addition
+  # to verify that values from all three sources land in the merged result.
+  deployment_defaults:
+    replicas: 1
+    strategy:
+      type: RollingUpdate
+      rollingUpdate:
+        maxSurge: 1
+    pod_annotations:
+      prometheus.io/scrape: "true"
+
+  deployment_custom:
+    replicas: 3
+
+  deployment_annotations:
+    pod_annotations:
+      custom.io/annotation: test-value
+
+  merged_deployment: ${merge:${deployment_defaults}, ${deployment_custom}, ${deployment_annotations}}

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/overwrite.yml

@@ -0,0 +1,17 @@
+---
+parameters:
+  # Base object for override demonstration
+  overwrite_base:
+    key_a: value_a
+    key_b: value_b
+    nested:
+      child: original
+
+  # Override via merge resolver (deep merge)
+  overwrite_override:
+    nested:
+      child: replaced
+    key_c: value_c
+
+  # Demonstrate override behavior
+  overwrite_result: ${merge:${overwrite_base}, ${overwrite_override}}

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/relative.yml

@@ -0,0 +1,4 @@
+---
+parameters:
+  relative_value: from_relative
+  relative_demo: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/classes/features/remove.yml

@@ -0,0 +1,22 @@
+---
+parameters:
+  omegaconf:
+    remove:
+      - base_component
+      - service_defaults
+      - deployment_defaults
+
+  base_component:
+    name: base
+    namespace: ${namespace}
+    labels:
+      app: base-app
+
+  service_defaults:
+    type: ClusterIP
+    port: 80
+
+  deployment_defaults:
+    replicas: 1
+    strategy:
+      type: RollingUpdate

kapitan-0.35.2.dev32/examples/omegaconf/inventory/resolvers.py

@@ -0,0 +1,56 @@
+import os
+
+
+def double(x: int):
+    """Multiply a number by two."""
+    return x * 2
+
+
+def concat(a: str, b: str):
+    """Concatenate two strings."""
+    return a + b
+
+
+def env_or_default(name: str, default: str):
+    """Read an environment variable with a safe deterministic default."""
+    return os.environ.get(name, default)
+
+
+def get_suffix(name: str):
+    """Extract the last part of a hyphen-separated string."""
+    return name.split("-")[-1]
+
+
+def get_substr(name: str, substr: int = -2):
+    """Extract a specific part of a hyphen-separated string by index."""
+    return name.split("-")[substr]
+
+
+def upper(content: str):
+    """Convert string to uppercase."""
+    return content.upper()
+
+
+def capitalize(input_str: str):
+    """Capitalize hyphenated words (camelCase style)."""
+    parts = input_str.split("-")
+    return parts[0] + "".join([x.capitalize() for x in parts[1:]])
+
+
+def with_root(*args, _root_):
+    """Demonstrate _root_ context access by building a path from target_name."""
+    target_name = _root_.target_name
+    return f"{target_name}/" + "/".join(args)
+
+
+def pass_resolvers():
+    return {
+        "double": double,
+        "concat": concat,
+        "env_or_default": env_or_default,
+        "get_suffix": get_suffix,
+        "get_substr": get_substr,
+        "upper": upper,
+        "capitalize": capitalize,
+        "with_root": with_root,
+    }

kapitan-0.35.2.dev32/examples/omegaconf/inventory/targets/advanced.yml

@@ -0,0 +1,40 @@
+---
+classes:
+  - common
+  - features.merge
+  - features.overwrite
+  - features.init
+  - features.relative
+  - features.deferred
+  - features.empty
+  - features.remove
+  - features.functions
+
+parameters:
+  # Test conditional resolvers
+  feature_enabled: true
+  feature_disabled: false
+
+  conditional_result: ${if:${feature_enabled},enabled_value}
+  conditional_else: ${ifelse:${equal:${environment},dev},development_mode,production_mode}
+
+  # Test arithmetic resolver
+  computed_replicas: ${add:${replicas}, ${replicas}}
+
+  # Test custom resolver (concat)
+  custom_concat: ${concat:hello,world}
+
+  # Test custom resolver (double)
+  custom_double: ${double:${replicas}}
+
+  # Test escape resolver mid-string
+  greeting: "Hello ${escape:USER}, welcome to ${app_name}"
+
+  kapitan:
+    compile:
+      - input_type: jinja2
+        input_paths:
+          - templates/output.yaml.j2
+        output_path: .
+        output_type: yaml
+        suffix_remove: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/targets/basic.yml

@@ -0,0 +1,14 @@
+---
+classes:
+  - common
+  - features.interpolation
+
+parameters:
+  kapitan:
+    compile:
+      - input_type: jinja2
+        input_paths:
+          - templates/output.yaml.j2
+        output_path: .
+        output_type: yaml
+        suffix_remove: true

kapitan-0.35.2.dev32/examples/omegaconf/inventory/targets/compile-test.yml

@@ -0,0 +1,15 @@
+---
+classes:
+  - common
+  - features.interpolation
+  - features.merge
+
+parameters:
+  kapitan:
+    compile:
+      - input_type: jinja2
+        input_paths:
+          - templates/output.yaml.j2
+        output_path: .
+        output_type: yaml
+        suffix_remove: true

kapitan-0.35.2.dev32/examples/omegaconf/templates/output.yaml.j2

@@ -0,0 +1,103 @@
+---
+# Rendered by omegaconf example
+app_name: {{ inventory.parameters.app_name }}
+environment: {{ inventory.parameters.environment }}
+namespace: {{ inventory.parameters.namespace }}
+interpolated: {{ inventory.parameters.interpolated | default('unknown') }}
+{% if inventory.parameters.nested_interpolated is defined %}
+nested_interpolated: {{ inventory.parameters.nested_interpolated }}
+{% endif %}
+{% if inventory.parameters.full_name is defined %}
+full_name: {{ inventory.parameters.full_name }}
+{% endif %}
+{% if inventory.parameters.ref_value is defined %}
+ref_value: {{ inventory.parameters.ref_value }}
+{% endif %}
+{% if inventory.parameters.deferred_value is defined %}
+deferred_value: {{ inventory.parameters.deferred_value }}
+{% endif %}
+{% if inventory.parameters.escaped_value is defined %}
+escaped_value: {{ inventory.parameters.escaped_value }}
+{% endif %}
+{% if inventory.parameters.escaped_real_key is defined %}
+escaped_real_key: {{ inventory.parameters.escaped_real_key }}
+{% endif %}
+{% if inventory.parameters.conditional_false is defined %}
+conditional_false: {{ inventory.parameters.conditional_false }}
+{% endif %}
+{% if inventory.parameters.merged_service is defined %}
+merged_service_port: {{ inventory.parameters.merged_service.port | default(0) }}
+{% endif %}
+{% if inventory.parameters.conditional_result is defined %}
+conditional_result: {{ inventory.parameters.conditional_result }}
+{% endif %}
+{% if inventory.parameters.conditional_else is defined %}
+conditional_else: {{ inventory.parameters.conditional_else }}
+{% endif %}
+{% if inventory.parameters.computed_replicas is defined %}
+computed_replicas: {{ inventory.parameters.computed_replicas }}
+{% endif %}
+{% if inventory.parameters.custom_concat is defined %}
+custom_concat: {{ inventory.parameters.custom_concat }}
+{% endif %}
+{% if inventory.parameters.custom_double is defined %}
+custom_double: {{ inventory.parameters.custom_double }}
+{% endif %}
+{% if inventory.parameters.greeting is defined %}
+greeting: {{ inventory.parameters.greeting }}
+{% endif %}
+{% if inventory.parameters.overwrite_result is defined %}
+overwrite_result:
+  key_a: {{ inventory.parameters.overwrite_result.key_a }}
+  key_b: {{ inventory.parameters.overwrite_result.key_b }}
+  nested_child: {{ inventory.parameters.overwrite_result.nested.child }}
+  key_c: {{ inventory.parameters.overwrite_result.key_c }}
+{% endif %}
+{% if inventory.parameters.relative_value is defined %}
+relative_value: {{ inventory.parameters.relative_value }}
+{% endif %}
+{% if inventory.parameters.relative_demo is defined %}
+relative_demo: {{ inventory.parameters.relative_demo }}
+{% endif %}
+{% if inventory.parameters.init_value is defined %}
+init_value: {{ inventory.parameters.init_value }}
+{% endif %}
+{% if inventory.parameters.init_child is defined %}
+init_child: {{ inventory.parameters.init_child }}
+{% endif %}
+{% if inventory.parameters.init_common is defined %}
+init_common: {{ inventory.parameters.init_common }}
+{% endif %}
+{% if inventory.parameters.empty_test is defined %}
+empty_test_loaded: {{ inventory.parameters.empty_test.loaded }}
+{% endif %}
+{% if inventory.parameters.bool_and is defined %}
+bool_and: {{ inventory.parameters.bool_and }}
+{% endif %}
+{% if inventory.parameters.bool_or is defined %}
+bool_or: {{ inventory.parameters.bool_or }}
+{% endif %}
+{% if inventory.parameters.bool_not is defined %}
+bool_not: {{ inventory.parameters.bool_not }}
+{% endif %}
+{% if inventory.parameters.bool_equal is defined %}
+bool_equal: {{ inventory.parameters.bool_equal }}
+{% endif %}
+{% if inventory.parameters.if_numeric is defined %}
+if_numeric: {{ inventory.parameters.if_numeric }}
+{% endif %}
+{% if inventory.parameters.write_result is defined %}
+write_result: {{ inventory.parameters.write_result }}
+{% endif %}
+{% if inventory.parameters.nested_func is defined %}
+nested_func: {{ inventory.parameters.nested_func }}
+{% endif %}
+{% if inventory.parameters.parentkey_test is defined %}
+parentkey_test_name: {{ inventory.parameters.parentkey_test.name }}
+{% endif %}
+{% if inventory.parameters.default_result is defined %}
+default_result: {{ inventory.parameters.default_result }}
+{% endif %}
+{% if inventory.parameters.access_result is defined %}
+access_result: {{ inventory.parameters.access_result }}
+{% endif %}

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/common.yml

@@ -0,0 +1,12 @@
+---
+parameters:
+  target_name: ${_reclass_:name:short}
+
+  app_name: reclass-test
+  environment: dev
+  namespace: default
+  base_url: https://${app_name}.example.com
+
+  kapitan:
+    vars:
+      target: ${target_name}

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/components/app.yml

@@ -0,0 +1,15 @@
+---
+classes:
+  - features.lists
+
+parameters:
+  app_name: myapp
+
+  # List override (reclass replaces lists by default)
+  tags:
+    - app-tag
+
+  # Dictionary merge / override demonstration
+  config:
+    port: 8080
+    timeout: 30

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/components/db.yml

@@ -0,0 +1,5 @@
+---
+parameters:
+  db_host: localhost
+  db_port: 5432
+  db_name: mydb

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/features/dicts.yml

@@ -0,0 +1,13 @@
+---
+parameters:
+  # Base dictionary for merge demonstration
+  config:
+    log_level: info
+    retries: 3
+    nested:
+      key_a: value_a
+
+  # Another dictionary for override demonstration
+  metadata:
+    team: platform
+    version: 1.0.0

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/features/exports.yml

@@ -0,0 +1,9 @@
+---
+classes:
+  - features.dicts
+
+exports:
+  exported_app_name: ${app_name}
+  exported_config:
+    log_level: ${config:log_level}
+    retries: ${config:retries}

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/features/interpolation.yml

@@ -0,0 +1,13 @@
+---
+parameters:
+  # Standard interpolation
+  interpolated: ${app_name}
+
+  # Nested interpolation (interpolation result used inside another interpolation)
+  nested_interpolated: ${base_url}
+
+  # Escaped interpolation (preserved as literal string)
+  escaped_value: \${app_name}
+
+  # Parameter path reference
+  ref_value: ${config:log_level}

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/features/lists.yml

@@ -0,0 +1,11 @@
+---
+parameters:
+  # Base list parameter
+  tags:
+    - base-tag
+    - common
+
+  # Another list for override demonstration
+  features:
+    - logging
+    - metrics

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/nested/child.yml

@@ -0,0 +1,7 @@
+---
+classes:
+  - nested
+
+parameters:
+  child_value: from_child
+  child_override: base

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/nested/init.yml

@@ -0,0 +1,6 @@
+---
+# Reclass init class convention:
+# When a class name resolves to a directory, reclass loads <dir>/init.yml
+parameters:
+  init_value: from_init
+  init_common: true

kapitan-0.35.2.dev32/examples/reclass/inventory/classes/relative/sibling.yml

@@ -0,0 +1,4 @@
+---
+parameters:
+  sibling_value: from_sibling
+  relative_demo: true