How k0rdent/catalog works
Project type and purpose
• This is an infrastructure‐as‐code/catalog repository, not a traditional full‐stack app.
• It serves two main functions:
• Maintain a curated catalog of Helm charts and Kubernetes resources under apps/.
• Generate and deploy a static documentation/website via MkDocs (mkdocs/, docs/, overrides/, mkdocs.yml).
• CI/CD (in .github/workflows/) automates testing of charts, building the site, and deploying artifacts.
File‐structure analysis
• Top-level directories:
• .github/workflows/ – GitHub Action YAMLs for testing, cleaning artifacts, building Helm charts, deploying the MkDocs site to GitHub Pages.
• apps/ – Hundreds of subfolders, each containing:
– charts/ (versioned Helm charts and service-template wrappers)
– data.yaml (metadata for catalog entries)
– example/ (sample values and Chart.yaml)
• mkdocs/ and docs/ – Source Markdown, templates, and CSS for documentation.
• overrides/ – HTML/Liquid overrides to customize the MkDocs theme.
• scripts/ – Python and shell utilities to lint, test (via Kind or cluster config), package, and deploy charts.
• Key config files: mkdocs.yml for site build, scripts/requirements.txt, various config/*.yaml for test clusters, chart_ctl.py and cluster‐management scripts.