Skip to content

Add helm chart #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
honghainguyen777 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add helm chart #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
41d3af0
Add nrr-controller Helm chart
honghainguyen777 Mar 11, 2026
3cb5e6d
Update README.md & remove temp files
honghainguyen777 Mar 11, 2026
d2698f7
Add test config
honghainguyen777 Mar 12, 2026
92d2a01
Add missing eof
honghainguyen777 Mar 12, 2026
6bbc155
Fix wrong helm branch - github workflows
honghainguyen777 Mar 12, 2026
9035670
Update crds & rbac & tolerations for image v0.3.0
honghainguyen777 Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ci/ct.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
chart-dirs:
- charts
helm-extra-args: "--timeout=5m"
check-version-increment: false
target-branch: main
70 changes: 70 additions & 0 deletions .github/workflows/helm.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Helm

on:
push:
branches:
- main
- release-*
paths:
- 'charts/**'
- '.github/workflows/helm.yaml'
- '.github/ci/ct.yaml'
pull_request:
paths:
- 'charts/**'
- '.github/workflows/helm.yaml'
- '.github/ci/ct.yaml'

jobs:
lint-and-test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Helm
uses: azure/setup-helm@v4.2.0
with:
version: v3.15.1

- uses: actions/setup-python@v5.1.1
with:
python-version: 3.12

- uses: actions/setup-go@v5
with:
go-version-file: 'go.mod'

- name: Set up chart-testing
uses: helm/chart-testing-action@v2.8.0
with:
version: v3.11.0

- name: Install Helm Unit Test Plugin
run: |
helm plugin install --version 1.0.3 https://github.com/helm-unittest/helm-unittest

- name: Run Helm Unit Tests
run: |
helm unittest charts/nrr-controller --strict -d

- name: Run chart-testing (list-changed)
id: list-changed
run: |
changed=$(ct list-changed --config=.github/ci/ct.yaml)
if [[ -n "$changed" ]]; then
echo "changed=true" >> $GITHUB_OUTPUT
fi

- name: Run chart-testing (lint)
run: ct lint --config=.github/ci/ct.yaml --validate-maintainers=false

# Need a multi node cluster so controller can run with leadership
- name: Create multi node Kind cluster
run: make kind-multi-node

# helm-extra-set-args only available after ct 3.6.0
- name: Run chart-testing (install)
run: ct install --config=.github/ci/ct.yaml --helm-extra-set-args='--set=kind=Deployment'
21 changes: 20 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,4 +477,23 @@ crd-ref-docs:
--source-path=${PWD}/api/v1alpha1/ \
--config=crd-ref-docs.yaml \
--renderer=markdown \
--output-path=${PWD}/docs/book/src/reference/api-spec.md
--output-path=${PWD}/docs/book/src/reference/api-spec.md

# helm

ensure-helm-install:
ifndef HAS_HELM
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 && chmod 700 ./get_helm.sh && ./get_helm.sh
endif

lint-chart: ensure-helm-install
helm lint ./charts/nrr-controller

build-helm:
helm package ./charts/nrr-controller --dependency-update --destination ./bin/chart

kind-multi-node:
kind create cluster --name kind --config ./hack/kind_config.yaml --wait 2m

ct-helm:
./hack/verify-chart.sh
22 changes: 22 additions & 0 deletions charts/nrr-controller/.helmignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
15 changes: 15 additions & 0 deletions charts/nrr-controller/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: v2
name: nrr-controller
description: A Helm chart for the Node Readiness Controller
type: application
version: 0.1.0
appVersion: "v0.3.0"
kubeVersion: ">=1.25.0-0"
home: https://github.com/kubernetes-sigs/node-readiness-controller
sources:
- https://github.com/kubernetes-sigs/node-readiness-controller
keywords:
- kubernetes
- controller
- readiness
- node
101 changes: 101 additions & 0 deletions charts/nrr-controller/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Node Readiness Controller for Kubernetes

[Node Readiness Controller](https://github.com/kubernetes-sigs/node-readiness-controller) for Kubernetes a Kubernetes controller that provides fine-grained, declarative readiness for nodes. It ensures nodes only accept workloads when all required components eg: network agents, GPU drivers, storage drivers or custom health-checks, are fully ready on the node.

## TL;DR:

```shell
helm repo add node-readiness-controller https://kubernetes-sigs.github.io/node-readiness-controller/
helm install my-release --namespace kube-system node-readiness-controller/nrr-controller
```

## Introduction

This chart bootstraps a [node-readiness-controller](https://github.com/kubernetes-sigs/node-readiness-controller) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Prerequisites

- Kubernetes 1.25+

## Installing the Chart

To install the chart with the release name `my-release`:

```shell
helm install --namespace kube-system my-release node-readiness-controller/nrr-controller
```

The command deploys the _node-readiness-controller_ on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

> **Tip**: List all releases using `helm list`

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```shell
helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Configuration

The following table lists the configurable parameters of the _node-readiness-controller_ chart and their default values.

| Parameter | Description | Default |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `image.repository` | Docker repository to use | `registry.k8s.io/node-readiness-controller/node-readiness-controller` |
| `image.tag` | Docker tag to use | `v[chart appVersion]` |
| `image.pullPolicy` | Docker image pull policy | `IfNotPresent` |
| `imagePullSecrets` | Docker repository secrets | `[]` |
| `nameOverride` | String to partially override `nrr-controller.fullname` template (will prepend the release name) | `""` |
| `fullnameOverride` | String to fully override `nrr-controller.fullname` template | `""` |
| `namespaceOverride` | Override the deployment namespace; defaults to .Release.Namespace | `""` |
| `replicaCount` | The replica count for Deployment | `1` |
| `leaderElection.enabled` | Enable leader election to support multiple replicas | `false` |
| `priorityClassName` | The name of the priority class to add to pods | `system-cluster-critical` |
| `rbac.create` | If `true`, create & use RBAC resources | `true` |
| `resources` | Node Readiness Controller container CPU and memory requests/limits | _see values.yaml_ |
| `serviceAccount.create` | If `true`, create a service account | `true` |
| `serviceAccount.name` | The name of the service account to use, if not set and create is true a name is generated using the fullname template | `nil` |
| `serviceAccount.annotations` | Specifies custom annotations for the serviceAccount | `{}` |
| `podAnnotations` | Annotations to add to the node-readiness-controller Pods | `{}` |
| `podLabels` | Labels to add to the node-readiness-controller Pods | `{}` |
| `commonLabels` | Labels to apply to all resources | `{}` |
| `podSecurityContext` | Security context for pod | _see values.yaml_ |
| `securityContext` | Security context for container | _see values.yaml_ |
| `terminationGracePeriodSeconds` | Time to wait before forcefully terminating the pod | `10` |
| `healthProbeBindAddress` | The bind address for health probes | `:8081` |
| `livenessProbe` | Liveness probe configuration for the node-readiness-controller container | _see values.yaml_ |
| `readinessProbe` | Readiness probe configuration for the node-readiness-controller container | _see values.yaml_ |
| `metrics.secure` | Enable secure metrics endpoint | `false` |
| `metrics.bindAddress` | The bind address for metrics server | `:8443` |
| `metrics.service.port` | The port exposed by the metrics service | `8443` |
| `metrics.service.targetPort` | The target port for the metrics service | `8443` |
| `metrics.certDir` | Directory for metrics server certificates | `/tmp/k8s-metrics-server/metrics-certs` |
| `metrics.certSecretName` | Name of the secret containing metrics server certificates | `metrics-server-cert` |
| `webhook.enabled` | Enable the webhook server | `false` |
| `webhook.port` | The port for the webhook server | `9443` |
| `webhook.service.port` | The port exposed by the webhook service | `8443` |
| `webhook.service.targetPort` | The target port for the webhook service | `9443` |
| `webhook.certDir` | Directory for webhook server certificates | `/tmp/k8s-webhook-server/serving-certs` |
| `webhook.certSecretName` | Name of the secret containing webhook server certificates | `webhook-server-certs` |
| `certManager.enabled` | Enable cert-manager integration for automatic TLS certificate generation | `false` |
| `certManager.issuer.create` | Create a cert-manager issuer | `true` |
| `certManager.issuer.name` | Name of the cert-manager issuer | `selfsigned-issuer` |
| `certManager.metricsCertificate.create` | Create a cert-manager certificate for metrics server | `true` |
| `certManager.metricsCertificate.name` | Name of the metrics certificate | `metrics-certs` |
| `certManager.webhookCertificate.create` | Create a cert-manager certificate for webhook server | `true` |
| `certManager.webhookCertificate.name` | Name of the webhook certificate | `serving-cert` |
| `validatingWebhook.enabled` | Enable the validating webhook | `false` |
| `validatingWebhook.name` | Name of the ValidatingWebhookConfiguration resource | `validating-webhook-configuration` |
| `validatingWebhook.webhookName` | Name of the webhook | `vnodereadinessrule.kb.io` |
| `validatingWebhook.failurePolicy` | Failure policy for the webhook | `Fail` |
| `validatingWebhook.sideEffects` | Side effects for the webhook | `None` |
| `validatingWebhook.path` | The path for the webhook | `/validate-readiness-node-x-k8s-io-v1alpha1-nodereadinessrule` |
| `validatingWebhook.admissionReviewVersions` | Admission review versions supported by the webhook | `["v1"]` |
| `nodeSelector` | Node selectors to run the controller on specific nodes | `nil` |
| `tolerations` | Tolerations to run the controller on specific nodes | `nil` |
| `affinity` | Node affinity to run the controller on specific nodes | `nil` |
| `nodeReadinessRules` | Custom NodeReadinessRule resources to create. CRD must be preinstalled or installation will fail. | `[]` |
Loading