wrale-charts

Wrale Helm Charts

This repository hosts official Helm charts for Wrale projects. Our charts follow best practices for Kubernetes deployments and aim to be secure, maintainable, and user-friendly.

Getting Started

Prerequisites

Installation

  1. Add the Wrale Helm repository:
    helm repo add wrale https://wrale.github.io/wrale-charts
    helm repo update
    
  2. View available charts:
    helm search repo wrale
    
  3. Install a chart:
    helm install my-release wrale/<chart-name>
    

Development Setup

Local Environment Setup

  1. Clone the repository:
    git clone https://github.com/wrale/wrale-charts.git
    cd wrale-charts
    
  2. Install development dependencies:
  3. Set up pre-commit hooks:
    pre-commit install
    

Creating a New Chart

  1. Create a new chart using the template:
    helm create charts/my-chart
    
  2. Update chart files following our Chart Guidelines

  3. Update documentation:
    helm-docs -c charts/my-chart
    
  4. Test your chart:
    ct lint --charts charts/my-chart
    helm test my-chart
    

Testing

Automated Testing

Our CI pipeline automatically runs:

Local Testing

  1. Lint your chart:
    helm lint charts/my-chart
    
  2. Run chart tests:
    helm test my-chart
    
  3. Validate templates:
    helm template charts/my-chart
    

Release Process

  1. Update Chart.yaml with new version

  2. Update CHANGELOG.md following our guidelines

  3. Submit a pull request with your changes

  4. Upon merge to main:

    • GitHub Actions will package the chart
    • Chart will be published to GitHub Pages
    • Release will be created automatically

Contributing

See CONTRIBUTING.md for guidelines.

Available Charts

See individual chart documentation in the charts/ directory.

Support

License

Apache License 2.0