/charts-fairwindsops

Fairwinds helm chart repository

Primary LanguageMustacheApache License 2.0Apache-2.0

Fairwinds Charts

CircleCI Fairwinds Insights

A repository of Helm charts. Modelled after https://github.com/helm/charts

Testing

All charts are linted and tested using Helm Chart Testing

Generating docs

Fairwinds charts are using helm-docs for automating the generation of docs. Before pushing your changes, run helm-docs --sort-values-order=file - this will add new values together with their documentation to the README of the chart. Ideally document the values via comments inside the values file itself - those comments will end up in the README as well.

Linting

Charts are linted using both the helm lint command and against the schema. This ensures that maintainers, versions, etc. are included.

e2e Testing

Charts are installed into a kind cluster. You can provide a folder called ci with a set of *-values.yaml files to provide overrides for the e2e test.

If you have any prerequisites to a chart install that cannot be performed by helm itself (e.g. manually installing CRDs from a remote location) you can place a shell (not bash) script in the ci folder of your chart. The script should be exactly named: pre-test-script.sh

Usage

To install a chart from this repo, you can add it as a helm repository

helm repo add fairwinds-stable https://charts.fairwinds.com/stable
helm search repo fairwinds-stable

Organization

Stable

These charts are considered stable for public consumption and use. See the criteria in the contributing document.

Incubator

These charts are considered alpha or beta and are not intended for public consumption outside of Fairwinds. They are frequently for very specific use-cases and can be broken at any time without warning. There are absolutely no guarantees in this folder.

Scripts

This folder includes scripts for testing the charts and syncing the repo.

Join the Fairwinds Open Source Community

The goal of the Fairwinds Community is to exchange ideas, influence the open source roadmap, and network with fellow Kubernetes users. Chat with us on Slack join the user group to get involved!

Love Fairwinds Open Source? Share your business email and job title and we'll send you a free Fairwinds t-shirt!

Other Projects from Fairwinds

Enjoying Charts? Check out some of our other projects:

  • Polaris - Audit, enforce, and build policies for Kubernetes resources, including over 20 built-in checks for best practices
  • Goldilocks - Right-size your Kubernetes Deployments by compare your memory and CPU settings against actual usage
  • Pluto - Detect Kubernetes resources that have been deprecated or removed in future versions
  • rbac-manager - Simplify the management of RBAC in your Kubernetes clusters