{"id":41544340,"url":"https://github.com/adobe/kompos","last_synced_at":"2026-01-30T05:15:54.682Z","repository":{"id":47676979,"uuid":"222483798","full_name":"adobe/kompos","owner":"adobe","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-07T18:05:28.000Z","size":219,"stargazers_count":19,"open_issues_count":2,"forks_count":12,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-11-07T20:08:27.030Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adobe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-18T15:39:35.000Z","updated_at":"2025-11-07T18:05:32.000Z","dependencies_parsed_at":"2025-11-07T20:01:18.757Z","dependency_job_id":"4f4c2200-3c5c-4896-a14a-fb18720e484f","html_url":"https://github.com/adobe/kompos","commit_stats":null,"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"purl":"pkg:github/adobe/kompos","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fkompos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fkompos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fkompos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fkompos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adobe","download_url":"https://codeload.github.com/adobe/kompos/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adobe%2Fkompos/sbom","scorecard":{"id":167286,"data":{"date":"2025-08-11","repo":{"name":"github.com/adobe/kompos","commit":"e2d1e24b5d7f57b7e692360b5137b5b0c14e4824"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-to-pypi.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":2,"reason":"Found 7/30 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-pypi.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/adobe/kompos/publish-to-pypi.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-pypi.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/adobe/kompos/publish-to-pypi.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-to-pypi.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/adobe/kompos/publish-to-pypi.yml/main?enable=pin","Warn: containerImage not pinned by hash: build_scripts/Dockerfile:1","Warn: containerImage not pinned by hash: build_scripts/Dockerfile:19: pin your Docker image by updating python:3.7-alpine3.12 to python:3.7-alpine3.12@sha256:3247d0d047db35f4db8d6400278ada68520fa2414010c6126c9f5472cb8a268e","Warn: pipCommand not pinned by hash: build_scripts/freeze_requirements.sh:5","Warn: pipCommand not pinned by hash: build_scripts/run_tests.sh:6","Warn: pipCommand not pinned by hash: build_scripts/run_tests.sh:7","Warn: pipCommand not pinned by hash: build_scripts/run_tests.sh:9","Warn: pipCommand not pinned by hash: .github/workflows/publish-to-pypi.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/publish-to-pypi.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/publish-to-pypi.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/publish-to-pypi.yml:32","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   8 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/adobe/.github/.github/SECURITY.md:1","Info: Found linked content: github.com/adobe/.github/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/adobe/.github/.github/SECURITY.md:1","Info: Found text in security policy: github.com/adobe/.github/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2020-176 / GHSA-3pqx-4fqf-j49f","Warn: Project is vulnerable to: PYSEC-2020-96 / GHSA-6757-jp84-gxfx","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 13 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T15:15:48.948Z","repository_id":47676979,"created_at":"2025-08-16T15:15:48.948Z","updated_at":"2025-08-16T15:15:48.948Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28707713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T23:51:44.727Z","status":"online","status_checked_at":"2026-01-24T02:00:06.909Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-24T02:19:29.255Z","updated_at":"2026-01-30T05:15:54.660Z","avatar_url":"https://github.com/adobe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kompos\n\n[![Build Status](https://www.travis-ci.com/adobe/kompos.svg?token=8uHqfhgsxdvJ93qWAxhn\u0026branch=main)](https://www.travis-ci.com/adobe/kompos) [![Docker pull](https://img.shields.io/docker/pulls/adobe/kompos)](https://hub.docker.com/r/adobe/kompos) [![](https://images.microbadger.com/badges/version/adobe/kompos.svg)](https://microbadger.com/images/adobe/kompos \"Get your own version badge on microbadger.com\") [![License](https://img.shields.io/github/license/adobe/kompos)](https://github.com/adobe/kompos/blob/master/LICENSE) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/kompos.svg)](https://pypi.python.org/pypi/kompos/)\n\n![kompos](img/kompos.png)\n\n**Kompos** is a configuration source management tool for infrastructure platforms. It maintains a Git-based layered\nconfiguration structure that generates environment-specific configurations for Terraform and other infrastructure tools.\n\n**Perfect for:** Multi-environment deployments, cell-based architectures, platform engineering teams managing 10s-100s\nof clusters.\n\n**Workflow:** Layered config source in Git → Kompos generates → Commit → Terraform/TFE consumes → Deploy\n\n## Key Features\n\n- **Layered Configuration**: Organize configs by cloud/environment/region/cluster with automatic inheritance and merge\n- **Generate Configurations**: Produce tfvars, workspace configs, and composition files for Terraform/TFE\n- **Value Interpolation**: Dynamic config resolution with `{{key.path}}` placeholders\n- **Configuration Analysis**: Trace value origins, visualize hierarchy, compare environments\n- **Extensible Runners**: Built-in Terraform and TFE runners, extensible architecture for custom destinations\n\n### Core Benefits\n\n- ✅ **Version Controlled**: All changes tracked in Git with full audit trail\n- ✅ **DRY at Scale**: Define once, inherit everywhere. Start with cluster-specific configs, refactor common patterns\n  upward to shared layers\n- ✅ **Clear Precedence**: Specific configs override general ones automatically\n- ✅ **Environment Variants**: Dev uses latest versions, prod uses stable - same codebase\n- ✅ **Effortless Updates**: Change one shared config file → update 50+ clusters instantly\n- ✅ **Clean Separation**: Source configs vs generated artifacts\n\nBelow is a graphical representation of the data flow, showing how hierarchical\nconfigurations are merged and interpolated before being injected into runners:\n\n![kompos-data-flow](img/kompos-diagram.svg)\n\n## Installation\n\n**Requirements:** Python 3.11 or higher\n\n### PyPI (Recommended for Users)\n\n```bash\n# Install\npip install kompos\n\n# Upgrade to latest version\npip install --upgrade kompos\n```\n\n### Using Virtual Environment (Recommended)\n\nUsing virtualenv for isolated installation:\n\n```bash\npip install virtualenv\nvirtualenv kompos-env\nsource kompos-env/bin/activate\n(kompos-env) pip install kompos\n(kompos-env) pip install --upgrade kompos\n(kompos-env) kompos --version\n```\n\n### Locally for Development\n\nUsing virtualenv with editable install:\n\n```bash\npip install virtualenv\nvirtualenv .env\nsource .env/bin/activate\n(env) cd kompos/\n(env) pip install --editable .\n```\n\n## Documentation\n\n- **[📖 Quick Guide](./docs/GUIDE.md)** - Get started in 5 minutes\n- **[📚 Advanced Guide](./docs/ADVANCED.md)** - Architecture, runners, debugging, best practices\n- **[💡 Examples](./examples/)** - Hands-on tutorials (beginner to advanced)\n- **[🧪 Testing](./tests/README.md)** - Run tests and add new ones\n\n## Testing\n\n```bash\n# Quick tests (no dependencies)\npython tests/run_tests.py\n\n# Comprehensive tests (requires pytest)\npip install pytest pyyaml\npytest tests/ -v\n```\n\nSee [tests/README.md](./tests/README.md) for details.\n\n## Layered Configuration\n\nKompos leverages [himl](https://github.com/adobe/himl) to provide a layered configuration structure as your **Git-based\nsource of truth**. Configuration files are organized hierarchically and automatically merged based on directory paths,\nenabling powerful inheritance patterns.\n\n**How it works:** Base configurations are defined at higher levels (e.g., cloud, region) and automatically inherited by\nmore specific levels (e.g., cell, cluster), with the ability to override any value at any level.\n\n**Ideal for cell-based architectures:** Define shared cell configuration once (networking, security, compliance), then\noverride per-cell specifics (capacity, module versions, feature flags). One config change can update an entire cell\ndeployment pattern.\n\n**The DRY workflow:**\n\n1. **Start specific** - Define per-cluster configs as you build\n2. **Spot patterns** - Notice repeated values across clusters\n3. **Refactor upward** - Move common config to shared layers (region → env → cloud)\n4. **Override when needed** - Keep only differences at cluster level\n\n**Example:** All clusters use `terraform_version: \"1.5.0\"` → Move to `cloud=aws/defaults.yaml` → One change updates\neverything.\n\nThis enables:\n\n- **Git-Based Workflow**: Config changes via PRs → Generate → Terraform/TFE consumes\n- **Config Inheritance**: Define once at base level, override only what differs\n- **Value Interpolation**: Reference values with `{{key.path}}` syntax\n- **Artifact Generation**: Produce tfvars, compositions, workspace configs for downstream tools\n- **Config Analysis**: Trace origins, visualize hierarchy, compare environments\n- **Scale**: Manage 50+ clusters from a handful of config files\n\n## Examples\n\nComprehensive examples are available in [`examples/`](./examples/) with a progressive learning path:\n\n1. **[Layered Configuration](./examples/01-hierarchical-config/)** - Learn configuration inheritance and merge behavior\n2. **[Module Version Pinning](./examples/02-module-version-pinning/)** - Dynamic Terraform module versioning with\n   `.tf.versioned` files\n3. **[Config Exploration](./examples/03-config-exploration/)** - Analyze and visualize configuration hierarchies\n4. **[TFE Multi-Cluster](./examples/04-tfe-multi-cluster/)** - Terraform Enterprise workspace and composition generation\n\nSee the [Examples README](./examples/README.md) for a complete guide with difficulty levels, time estimates, and\nlearning paths.\n\n## Usage\n\nGenerate configuration artifacts from layered config source for infrastructure tools:\n\n```bash\n# TFE: Generate workspace configs, tfvars, and compositions (primary)\nkompos \u003cconfig_path\u003e tfe generate\n\n# Terraform: Generate configs and run Terraform locally\nkompos \u003cconfig_path\u003e terraform \u003ccommand\u003e\n\n# Explore: Analyze config hierarchy and trace values\nkompos \u003cconfig_path\u003e explore \u003canalyze|trace|visualize|compare\u003e\n\n# Config: View merged configuration\nkompos \u003cconfig_path\u003e config --format yaml\n```\n\n**Workflow:** Generate configs → Commit → Terraform/TFE consumes → Deploy\n\n**Note:** helmfile runner is deprecated. For Kubernetes, use GitOps tools (ArgoCD/Flux) or the planned helm runner.\n\n### Common Config Commands\n\nThe `config` command supports all HIML arguments natively for flexible configuration viewing and debugging:\n\n```bash\n# Example path from hierarchical example\nCONFIG_PATH=\"examples/01-hierarchical-config/config/cloud=aws/env=dev/cluster=cluster1/composition=terraform/terraform=cluster\"\n\n# View full merged configuration\nkompos $CONFIG_PATH config\n\n# View as JSON\nkompos $CONFIG_PATH config --format json\n\n# Filter: show only specific keys\nkompos $CONFIG_PATH config --filter cluster --filter vpc\n\n# Exclude: hide specific keys\nkompos $CONFIG_PATH config --exclude terraform --exclude composition\n\n# Save to file\nkompos $CONFIG_PATH config --output-file merged-config.yaml\n\n# Wrap output under a key (useful for Terraform)\nkompos $CONFIG_PATH config --enclosing-key config\n\n# Skip interpolation validation (useful for templates with missing values)\nkompos $CONFIG_PATH config --skip-interpolation-validation\n\n# Skip secret resolution (faster for debugging)\nkompos $CONFIG_PATH config --skip-secrets\n\n# Combine multiple options\nkompos $CONFIG_PATH config \\\n  --filter cluster --filter vpc \\\n  --format json \\\n  --output-file cluster-vpc.json \\\n  --skip-secrets\n```\n\n**Tip:** Use `--filter` to inspect specific sections of your configuration during development and debugging.\n\n## Docker Image\n\nDocker images are not currently maintained. Please use PyPI installation for the latest version.\nDocker image [adobe/kompos](https://hub.docker.com/r/adobe/kompos)\n\n## License\n\n[Apache License 2.0](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadobe%2Fkompos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadobe%2Fkompos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadobe%2Fkompos/lists"}