chart

Introduction

This chart deploys ns-label-operator into Kubernetes cluster using the Helm package manager.

Prerequisites

• Kubernetes cluster with RBAC (Role-Based Access Control) enabled is required
• Helm 3.4.0 or newer

Configuration

Create namespace:

kubectl create ns <target-namespace>

Create a ConfigMap in the above created namespace to hold all the deployments you want to apply whenever specific label is applied to any namespace in your cluster. You can load multiple files and each file can include multiple YAML blocks (good way to ensure order). See role.yaml for example. The files must have *.yaml extension for the operator to read them.

Note, this step is required only because Helm doesn't allow for reference of external files yes. There is a PR to enable --include-file and --include-dir which when lands, will no longer require this step.

kubectl create cm <config-name> \
  --from-file deployments/role.yaml \
  --from-file deployments/exporter.yaml \
  -n <target-namespace>

Install the Chart

First, add the Helm repo:

helm repo add ns-label-operator https://charts.chmarny.dev
helm repo update

Then, install the chart:

helm install <name> ns-label-operator/ns-label-operator \
  --set triggerLabel=<label-name> \
  --set manifestConfigMap=<config-name> \
  -n <target-namespace> \

Set the manifestConfigMap to the name of ConfigMap created above. triggerLabel is the name of the label which should trigger the deployment.

See the Usage section for instructions on how to use ns-label-operator to apply custom deployments when any namespace in your cluster is labeled with specific label.

Verify installation

Once the chart is installed, verify the ns-label-operator pod is running in the target namespace:

kubectl get pods -n <target-namespace>

Uninstall the Chart

To uninstall/delete the ns-label-operator release:

helm uninstall <name> -n <target-namespace>

Configuration

The ns-label-operator Helm chart has the follow configuration options:

Parameter	Description	Default
debug	Sets logging to debug mode (verbose)	false
logAsJson	Outputs logs in JSON format	true
triggerLabel	The name of the label to monitor	``
manifestConfigMap	Name of the ConfigMap holding deployments	``

Disclaimer

This is my personal project and it does not represent my employer. While I do my best to ensure that everything works, I take no responsibility for issues caused by this code.

License

This software is released under the MIT