Skip to content

CLAUDE.md

Latest commit

 

History

History
104 lines (78 loc) · 3.72 KB

CLAUDE.md

File metadata and controls

104 lines (78 loc) · 3.72 KB
Raw

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is a collection of Kubernetes Helm charts maintained by christianhuth. Charts are published to https://charts.christianhuth.de and indexed on Artifact Hub.

Development Commands

Linting and Validation

# Run pre-commit hooks (includes helm-docs, helm-schema, markdownlint, changelog generation)
pre-commit run --all-files

# Lint a specific chart with chart-testing
ct lint --config .github/config/chart-testing.yaml --charts charts/<chart-name>

# Run helm lint on a chart
helm dependency update charts/<chart-name>
helm lint charts/<chart-name>

# Validate chart manifests against Kubernetes schemas
helm plugin install https://github.com/jtyr/kubeconform-helm  # if not installed
helm dependency update charts/<chart-name>
helm kubeconform --config .github/config/chart-kubeconform.yaml charts/<chart-name>

Unit Testing

# Install helm-unittest plugin (if not installed)
helm plugin install https://github.com/helm-unittest/helm-unittest.git

# Run unit tests for a chart
helm dependency update charts/<chart-name>
helm unittest charts/<chart-name>

Integration Testing

# Test chart installation in a kind cluster
ct install --config .github/config/chart-testing.yaml --charts charts/<chart-name>

Local Development with Minikube

# Set up minikube cluster
minikube start --addons=ingress --cpus=4 --memory=8g --profile=helm-charts-development
minikube profile helm-charts-development

# Install a chart for testing (use values-dev.yaml if available)
helm dependency update charts/<chart-name>
helm install <release-name> charts/<chart-name> -f charts/<chart-name>/values-dev.yaml

Chart Structure

Each chart in charts/ follows this structure:

  • Chart.yaml - Chart metadata, dependencies, and artifacthub.io annotations including change log
  • values.yaml - Default configuration values
  • values.schema.json - Auto-generated JSON schema (via helm-schema pre-commit hook)
  • README.md - Auto-generated documentation (via helm-docs pre-commit hook)
  • README.md.gotmpl - Template for README generation
  • templates/ - Kubernetes manifest templates
  • templates/_helpers.tpl - Template helper functions
  • values-dev.yaml - (optional) Values for local development/testing

Making Changes to a Chart

  1. Edit the chart files as needed
  2. Bump the version in Chart.yaml following semver
  3. Update the artifacthub.io/changes annotation in Chart.yaml with change entries: 
    artifacthub.io/changes: |
  - kind: added|changed|fixed|security|deprecated|removed
    description: Description of change
  4. Run pre-commit run --all-files to regenerate README.md, values.schema.json, and CHANGELOG.md
  5. Commit changes - CI pipeline will run linting, kubeconform validation, unit tests, and installation tests

CI Pipeline

The chart pipeline (.github/workflows/chart-pipeline.yml) runs on changes to charts/:

  1. Preparation - Detect changed charts
  2. Linting - artifacthub lint, chart-testing lint, helm lint
  3. Kubeconform - Validate rendered manifests against Kubernetes schemas
  4. Unit Testing - Run helm-unittest tests
  5. Testing - Install charts in kind cluster
  6. Releasing - (main branch only) Package and release charts

Key Dependencies

Charts commonly use Bitnami subcharts for databases:

  • PostgreSQL: oci://registry-1.docker.io/bitnamicharts/postgresql
  • MySQL: oci://registry-1.docker.io/bitnamicharts/mysql

External chart repos configured for chart-testing: