Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 2.1 KB

README.md

File metadata and controls

41 lines (34 loc) · 2.1 KB

Gatekeeper Library Chart

Helm chart to install Gatekeeper Library on Kubernetes.

Installation

Add the Helm repository.

helm repo add gatekeeper-library https://xenitab.github.io/gatekeeper-library/

Install the Gatekeeper Library with the Helm chart.

helm install gatekeeper-library/gatekeeper-library-templates --generate-name
helm install gatekeeper-library/gatekeeper-library-constraints --generate-name

The Helm chart is split into two as the first chart needs to install the templates then wait for the controller to create the CRDs, before the second chart can be installed. The constraints chart will also contain mutations as these were introduced at a later date and it would be difficult to rename the chart now.

The chart will not create a single resource if you install it as is, because it does not contain any default values. Have a look at the values.yaml for a template to start from.

Configuration

The following table lists the configurable parameters of the gatekeeper-library chart and their default values.

Key Type Default Description
namePrefix string "" Prefix to append before resource names
constraints list [] The constraints that should be created
constraints[].kind string "" Kind of the constraint
constraints[].name string "" Name of the constraint, should be unique in the list
constraints[].parameters list [] Additional parameters to pass to the constraint
mutationExcludedNamespaces list ["kube-system", "gatekeeper-system"] Namespaces to exclude from all mutations
assigns list [] The assigns that should be created
assigns[].name string "" Name of the assign, should be unique in the list

Testing

The chart is tested using the helm-unittest plugin. The plugin allows testing expected output from the chart without requiring a Kubernetes cluster. All tests should be located in the tests directory and should have the _test suffix in the filename.