Skip to content

Latest commit

 

History

History
121 lines (91 loc) · 2.66 KB

README.md

File metadata and controls

121 lines (91 loc) · 2.66 KB

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

  • Kubernetes 1.19+
  • Helm 3.13.0+
  • kubectl configured with access to your cluster

Installation

  1. Add the Wrale Helm repository:
helm repo add wrale https://wrale.github.io/wrale-charts
helm repo update
  1. View available charts:
helm search repo wrale
  1. 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
  1. Install development dependencies:
  1. Set up pre-commit hooks:
pre-commit install

Creating a New Chart

  1. Create a new chart using our template:
cp -r charts/app-template charts/my-chart

  1. Update chart files following our Chart Guidelines

  2. Update documentation:

helm-docs -c charts/my-chart
  1. Test your chart:
ct lint --config .github/ct.yaml --charts charts/my-chart
ct install --config .github/ct.yaml --charts charts/my-chart

Testing

Automated Testing

Our CI pipeline automatically runs:

  • YAML linting
  • Helm chart linting
  • Chart installation tests
  • Template validation
  • Schema validation

Local Testing

  1. Lint your chart:
ct lint --config .github/ct.yaml --charts charts/my-chart
  1. Install and test chart:
ct install --config .github/ct.yaml --charts charts/my-chart
  1. Validate templates:
helm template --debug 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
    • GitHub Release will be created automatically
    • Helm repository index will be updated

Contributing

See CONTRIBUTING.md for guidelines.

Available Charts

See individual chart documentation in the charts/ directory.

Support

License

Apache License 2.0