kompos 0.11.2

Kompos - cloud infrastructure automation

kompos

Kompos is a configuration source management tool for infrastructure platforms. It maintains a Git-based layered configuration structure that generates environment-specific configurations for Terraform, Helm, and other tools.

Perfect for: Multi-environment deployments, cell-based architectures, platform engineering teams managing 10s-100s of clusters.

Workflow: Layered config source in Git → Kompos generates → Commit → Terraform/TFE/ArgoCD consumes → Deploy

Key Features

• Layered Configuration: Organize configs by cloud/environment/region/cluster with automatic inheritance and merge
• Generate Configurations: Produce tfvars, workspace configs, rendered Helm values, and composition files
• Value Interpolation: Dynamic config resolution with {{key.path}} placeholders
• Configuration Analysis: Trace value origins, visualize hierarchy, compare environments
• Extensible Runners: Built-in Terraform, TFE, and Helm runners; extensible architecture for custom destinations

Core Benefits

• ✅ Version Controlled: All changes tracked in Git with full audit trail
• ✅ DRY at Scale: Define once, inherit everywhere. Start with cluster-specific configs, refactor common patterns upward to shared layers
• ✅ Clear Precedence: Specific configs override general ones automatically
• ✅ Environment Variants: Dev uses latest versions, prod uses stable - same codebase
• ✅ Effortless Updates: Change one shared config file → update 50+ clusters instantly
• ✅ Clean Separation: Source configs vs generated artifacts

Installation

Requirements: Python 3.11 or higher

PyPI (Recommended for Users)

# Install
pip install kompos

# Upgrade to latest version
pip install --upgrade kompos

Using Virtual Environment (Recommended)

Using virtualenv for isolated installation:

pip install virtualenv
virtualenv kompos-env
source kompos-env/bin/activate
(kompos-env) pip install kompos
(kompos-env) pip install --upgrade kompos
(kompos-env) kompos --version

Locally for Development

Using virtualenv with editable install:

pip install virtualenv
virtualenv .env
source .env/bin/activate
(env) cd kompos/
(env) pip install --editable .

Documentation

• 📖 Quick Guide - Get started in 5 minutes
• 📚 Advanced Guide - Architecture, runners, debugging, best practices
• 💡 Examples - Hands-on tutorials (beginner to advanced)
• 🧪 Testing - Run tests and add new ones

Testing

# Quick tests (no dependencies)
python tests/run_tests.py

# Comprehensive tests (requires pytest)
pip install pytest pyyaml
pytest tests/ -v

See tests/README.md for details.

Layered Configuration

Kompos leverages himl to provide a layered configuration structure as your Git-based source of truth. Configuration files are organized hierarchically and automatically merged based on directory paths, enabling powerful inheritance patterns.

How it works: Base configurations are defined at higher levels (e.g., cloud, region) and automatically inherited by more specific levels (e.g., cell, cluster), with the ability to override any value at any level.

Ideal for cell-based architectures: Define shared cell configuration once (networking, security, compliance), then override per-cell specifics (capacity, module versions, feature flags). One config change can update an entire cell deployment pattern.

The DRY workflow:

1. Start specific - Define per-cluster configs as you build
2. Spot patterns - Notice repeated values across clusters
3. Refactor upward - Move common config to shared layers (region → env → cloud)
4. Override when needed - Keep only differences at cluster level

Example: All clusters use terraform_version: "1.5.0" → Move to cloud=aws/defaults.yaml → One change updates everything.

This enables:

• Git-Based Workflow: Config changes via PRs → Generate → Terraform/TFE/ArgoCD consumes
• Config Inheritance: Define once at base level, override only what differs
• Value Interpolation: Reference values with {{key.path}} syntax
• Artifact Generation: Produce tfvars, Helm values, compositions, workspace configs for downstream tools
• Config Analysis: Trace origins, visualize hierarchy, compare environments
• Scale: Manage 50+ clusters from a handful of config files

Examples

Comprehensive examples are available in examples/ with a progressive learning path:

1. Layered Configuration - Configuration inheritance and merge behavior
2. Module Version Pinning - Dynamic Terraform module versioning with .tf.versioned files
3. Config Exploration - Analyze and visualize configuration hierarchies
4. TFE Multi-Cluster - Terraform Enterprise workspace and composition generation per cluster
5. Helm Values Rendering - Render cluster-specific Helm values from hierarchy + TFE outputs for ArgoCD

See the Examples README for a complete guide with difficulty levels, time estimates, and learning paths.

Usage

Generate configuration artifacts from layered config source for infrastructure and Kubernetes delivery tools:

# TFE: Generate workspace configs, tfvars, and compositions
kompos <config_path> tfe generate

# Helm: Render cluster-specific Helm values from hierarchy + TFE outputs
kompos <config_path> helm generate
kompos <config_path> helm generate --chart-dir /path/to/my-chart  # single chart (local dev)
kompos <config_path> helm list                                      # show enabled charts

# Terraform: Generate configs and run Terraform locally
kompos <config_path> terraform <command>

# Explore: Analyze config hierarchy and trace values
kompos <config_path> explore <analyze|trace|visualize|compare>

# Config: View merged configuration
kompos <config_path> config --format yaml

Workflow: Generate configs → Commit → Terraform/TFE/ArgoCD consumes → Deploy

Note: helmfile runner is deprecated. Use the helm runner for Helm values rendering with ArgoCD/Flux delivery.

Common Config Commands

The config command supports all HIML arguments natively for flexible configuration viewing and debugging:

# Example path from hierarchical example
CONFIG_PATH="examples/01-hierarchical-config/config/cloud=aws/env=dev/cluster=cluster1/composition=terraform/terraform=cluster"

# View full merged configuration
kompos $CONFIG_PATH config

# View as JSON
kompos $CONFIG_PATH config --format json

# Filter: show only specific keys
kompos $CONFIG_PATH config --filter cluster --filter vpc

# Exclude: hide specific keys
kompos $CONFIG_PATH config --exclude terraform --exclude composition

# Save to file
kompos $CONFIG_PATH config --output-file merged-config.yaml

# Wrap output under a key (useful for Terraform)
kompos $CONFIG_PATH config --enclosing-key config

# Skip interpolation validation (useful for templates with missing values)
kompos $CONFIG_PATH config --skip-interpolation-validation

# Skip secret resolution (faster for debugging)
kompos $CONFIG_PATH config --skip-secrets

# Combine multiple options
kompos $CONFIG_PATH config \
  --filter cluster --filter vpc \
  --format json \
  --output-file cluster-vpc.json \
  --skip-secrets

Tip: Use --filter to inspect specific sections of your configuration during development and debugging.

Docker Image

Docker images are not currently maintained. Please use PyPI installation for the latest version. Docker image adobe/kompos

License

Apache License 2.0