rename Helm chart from nrr-controller to node-readiness-controller

.github/workflows/helm.yaml

@@ -60,7 +60,7 @@ jobs:
 
       - name: Run Helm Unit Tests
         run: |
-          helm unittest charts/nrr-controller --strict -d
+          helm unittest charts/node-readiness-controller --strict -d
 
       - name: Run chart-testing (list-changed)
         id: list-changed

Makefile

@@ -490,17 +490,17 @@ crd-ref-docs:
 HELM ?= go run helm.sh/helm/v3/cmd/helm@v3.15.1
 
 lint-chart:
-	$(HELM) lint ./charts/nrr-controller
+	$(HELM) lint ./charts/node-readiness-controller
 
 inject-helm-version: ## Inject the release version into the Helm chart's appVersion and image tag
-	sed 's/tag: .*/tag: "$(RELEASE_VERSION)"/' charts/nrr-controller/values.yaml > charts/nrr-controller/values.yaml.tmp && mv charts/nrr-controller/values.yaml.tmp charts/nrr-controller/values.yaml
-	sed 's/^appVersion: .*/appVersion: "$(RELEASE_VERSION)"/' charts/nrr-controller/Chart.yaml > charts/nrr-controller/Chart.yaml.tmp && mv charts/nrr-controller/Chart.yaml.tmp charts/nrr-controller/Chart.yaml
+	sed 's/tag: .*/tag: "$(RELEASE_VERSION)"/' charts/node-readiness-controller/values.yaml > charts/node-readiness-controller/values.yaml.tmp && mv charts/node-readiness-controller/values.yaml.tmp charts/node-readiness-controller/values.yaml
+	sed 's/^appVersion: .*/appVersion: "$(RELEASE_VERSION)"/' charts/node-readiness-controller/Chart.yaml > charts/node-readiness-controller/Chart.yaml.tmp && mv charts/node-readiness-controller/Chart.yaml.tmp charts/node-readiness-controller/Chart.yaml
 
 build-helm: inject-helm-version
-	$(HELM) package ./charts/nrr-controller --dependency-update --destination ./bin/chart
+	$(HELM) package ./charts/node-readiness-controller --dependency-update --destination ./bin/chart
 
 publish-helm: ## Publish the packaged Helm chart to an OCI registry
-	$(HELM) push ./bin/chart/nrr-controller-*.tgz oci://$(HELM_IMAGE)
+	$(HELM) push ./bin/chart/node-readiness-controller-*.tgz oci://$(HELM_IMAGE)
 
 kind-multi-node:
 	kind create cluster --name $(KIND_CLUSTER) --config ./config/testing/kind/kind-3node-config.yaml --wait 2m

RELEASE.md

@@ -34,9 +34,9 @@ After the release tag is pushed, the images and Helm chart must be built, pushed
   ```sh
   skopeo list-tags docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/node-readiness-controller | grep vX.Y.Z
   ```
-- Verify the chart exists in the staging repository (replace `<chart-version>` with the version in `charts/nrr-controller/Chart.yaml` at the tagged commit):
+- Verify the chart exists in the staging repository (replace `<chart-version>` with the version in `charts/node-readiness-controller/Chart.yaml` at the tagged commit):
   ```sh
-  helm pull oci://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/nrr-controller --version <chart-version>
+  helm pull oci://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/node-readiness-controller --version <chart-version>
   ```
 
 ### B. Create PR for Promotion
@@ -47,7 +47,7 @@ After the release tag is pushed, the images and Helm chart must be built, pushed
   ```
 - Identify the chart digest:
   ```sh
-  skopeo inspect --raw docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/nrr-controller:<chart-version> | sha256sum
+  skopeo inspect --raw docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/node-readiness-controller:<chart-version> | sha256sum
   ```
   Alternatively, note the digest printed by `helm push`/`helm pull` when the chart was published/verified above.
 - Fork [kubernetes/k8s.io](https://github.com/kubernetes/k8s.io).
@@ -68,7 +68,7 @@ Before publishing the release, verify the images and chart are available at k8s-
   ```
 - Ensure the chart is available at `registry.k8s.io`:
   ```sh
-  helm pull oci://registry.k8s.io/node-readiness-controller/charts/nrr-controller --version <chart-version>
+  helm pull oci://registry.k8s.io/node-readiness-controller/charts/node-readiness-controller --version <chart-version>
   ```
 
 ### B. Test Release Artifacts

charts/nrr-controller/Chart.yaml → charts/node-readiness-controller/Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: nrr-controller
+name: node-readiness-controller
 description: A Helm chart for the Node Readiness Controller
 type: application
 version: 0.1.0

charts/nrr-controller/README.md → charts/node-readiness-controller/README.md

@@ -7,7 +7,7 @@
 ```shell
 git clone https://github.com/kubernetes-sigs/node-readiness-controller.git
 cd node-readiness-controller
-helm install my-release --namespace nrr-system --create-namespace ./charts/nrr-controller
+helm install my-release --namespace nrr-system --create-namespace ./charts/node-readiness-controller
 ```
 
 > Published chart releases via `registry.k8s.io` OCI are WIP.
@@ -25,7 +25,7 @@ This chart bootstraps a [node-readiness-controller](https://github.com/kubernete
 To install the chart with the release name `my-release`:
 
 ```shell
-helm install --namespace nrr-system --create-namespace my-release ./charts/nrr-controller
+helm install --namespace nrr-system --create-namespace my-release ./charts/node-readiness-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.
@@ -34,7 +34,7 @@ The command deploys the _node-readiness-controller_ on the Kubernetes cluster in
 
 ## CRD Upgrades
 
-Helm installs CRDs from the chart `crds/` directory during initial install, but Helm does not upgrade or delete CRDs from that directory during `helm upgrade` or `helm uninstall`. Before upgrading to a chart version that changes the `NodeReadinessRule` schema, apply the updated CRD from the release artifacts or from `charts/nrr-controller/crds`.
+Helm installs CRDs from the chart `crds/` directory during initial install, but Helm does not upgrade or delete CRDs from that directory during `helm upgrade` or `helm uninstall`. Before upgrading to a chart version that changes the `NodeReadinessRule` schema, apply the updated CRD from the release artifacts or from `charts/node-readiness-controller/crds`.
 
 ## Uninstalling the Chart
 
@@ -56,8 +56,8 @@ The following table lists the configurable parameters of the _node-readiness-con
 | `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                                                                      | `""`                                                              |
+| `nameOverride`                           | String to partially override `node-readiness-controller.fullname` template (will prepend the release name)                                 | `""`                                                              |
+| `fullnameOverride`                       | String to fully override `node-readiness-controller.fullname` template                                                                      | `""`                                                              |
 | `namespaceOverride`                      | Override the deployment namespace; defaults to .Release.Namespace                                                               | `""`                                                              |
 | `replicaCount`                           | The replica count for Deployment                                                                                                | `1`                                                               |
 | `controller.kubeAPIQPS`                  | Maximum QPS to the Kubernetes API server. `-1` means no limit.                                                                  | `-1`                                                              |

charts/nrr-controller/templates/_helpers.tpl → charts/node-readiness-controller/templates/_helpers.tpl

@@ -2,7 +2,7 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "nrr-controller.name" -}}
+{{- define "node-readiness-controller.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
@@ -11,11 +11,11 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "nrr-controller.fullname" -}}
+{{- define "node-readiness-controller.fullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
-{{- $name := include "nrr-controller.name" . -}}
+{{- $name := include "node-readiness-controller.name" . -}}
 {{- if contains $name .Release.Name -}}
 {{- .Release.Name | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -28,23 +28,23 @@ If release name contains chart name it will be used as a full name.
 Expand the namespace of the release.
 Allows overriding it for multi-namespace deployments in combined charts.
 */}}
-{{- define "nrr-controller.namespace" -}}
+{{- define "node-readiness-controller.namespace" -}}
 {{- default .Release.Namespace .Values.namespaceOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "nrr-controller.chart" -}}
+{{- define "node-readiness-controller.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 {{/*
 Common labels
 */}}
-{{- define "nrr-controller.labels" -}}
-app.kubernetes.io/name: {{ include "nrr-controller.name" . }}
-helm.sh/chart: {{ include "nrr-controller.chart" . }}
+{{- define "node-readiness-controller.labels" -}}
+app.kubernetes.io/name: {{ include "node-readiness-controller.name" . }}
+helm.sh/chart: {{ include "node-readiness-controller.chart" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
@@ -58,18 +58,18 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{/*
 Selector labels
 */}}
-{{- define "nrr-controller.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "nrr-controller.name" . }}
+{{- define "node-readiness-controller.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "node-readiness-controller.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 control-plane: controller-manager
 {{- end -}}
 
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "nrr-controller.serviceAccountName" -}}
+{{- define "node-readiness-controller.serviceAccountName" -}}
 {{- if .Values.serviceAccount.create -}}
-    {{ default (include "nrr-controller.fullname" .) .Values.serviceAccount.name }}
+    {{ default (include "node-readiness-controller.fullname" .) .Values.serviceAccount.name }}
 {{- else -}}
     {{ default "default" .Values.serviceAccount.name }}
 {{- end -}}

charts/node-readiness-controller/templates/certificates.yaml

@@ -0,0 +1,44 @@
+{{- if and .Values.certManager.enabled .Values.certManager.metricsCertificate.create .Values.metrics.enabled .Values.metrics.secure }}
+---
+apiVersion: cert-manager.io/v1
+kind: Certificate
+metadata:
+  name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.metricsCertificate.name }}
+  namespace: {{ include "node-readiness-controller.namespace" . }}
+  labels:
+    {{- include "node-readiness-controller.labels" . | nindent 4 }}
+spec:
+  secretName: {{ .Values.metrics.certSecretName }}
+  {{- with .Values.certManager.certificateSubject }}
+  subject:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  dnsNames:
+    - {{ include "node-readiness-controller.fullname" . }}-metrics-service.{{ include "node-readiness-controller.namespace" . }}.svc
+    - {{ include "node-readiness-controller.fullname" . }}-metrics-service.{{ include "node-readiness-controller.namespace" . }}.svc.cluster.local
+  issuerRef:
+    kind: Issuer
+    name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.issuer.name }}
+{{- end }}
+{{- if and .Values.certManager.enabled .Values.webhook.enabled .Values.certManager.webhookCertificate.create }}
+---
+apiVersion: cert-manager.io/v1
+kind: Certificate
+metadata:
+  name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.webhookCertificate.name }}
+  namespace: {{ include "node-readiness-controller.namespace" . }}
+  labels:
+    {{- include "node-readiness-controller.labels" . | nindent 4 }}
+spec:
+  secretName: {{ .Values.webhook.certSecretName }}
+  {{- with .Values.certManager.certificateSubject }}
+  subject:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  dnsNames:
+    - {{ include "node-readiness-controller.fullname" . }}-webhook-service.{{ include "node-readiness-controller.namespace" . }}.svc
+    - {{ include "node-readiness-controller.fullname" . }}-webhook-service.{{ include "node-readiness-controller.namespace" . }}.svc.cluster.local
+  issuerRef:
+    kind: Issuer
+    name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.issuer.name }}
+{{- end }}

charts/nrr-controller/templates/deployment.yaml → charts/node-readiness-controller/templates/deployment.yaml

@@ -1,28 +1,28 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ include "nrr-controller.fullname" . }}-manager
-  namespace: {{ include "nrr-controller.namespace" . }}
+  name: {{ include "node-readiness-controller.fullname" . }}-manager
+  namespace: {{ include "node-readiness-controller.namespace" . }}
   labels:
-    {{- include "nrr-controller.labels" . | nindent 4 }}
+    {{- include "node-readiness-controller.labels" . | nindent 4 }}
 spec:
   replicas: {{ .Values.replicaCount }}
   selector:
     matchLabels:
-      {{- include "nrr-controller.selectorLabels" . | nindent 6 }}
+      {{- include "node-readiness-controller.selectorLabels" . | nindent 6 }}
   template:
     metadata:
       annotations:
         {{- if .Values.podAnnotations }}
           {{- .Values.podAnnotations | toYaml | nindent 10 }}
         {{- end }}
       labels:
-        {{- include "nrr-controller.selectorLabels" . | nindent 8 }}
+        {{- include "node-readiness-controller.selectorLabels" . | nindent 8 }}
         {{- with .Values.podLabels }}
         {{- toYaml . | nindent 8 }}
         {{- end }}
     spec:
-      serviceAccountName: {{ include "nrr-controller.serviceAccountName" . }}
+      serviceAccountName: {{ include "node-readiness-controller.serviceAccountName" . }}
       {{- with .Values.imagePullSecrets }}
       imagePullSecrets:
         {{- toYaml . | nindent 8 }}

charts/node-readiness-controller/templates/issuer.yaml

@@ -0,0 +1,11 @@
+{{- if and .Values.certManager.enabled .Values.certManager.issuer.create }}
+apiVersion: cert-manager.io/v1
+kind: Issuer
+metadata:
+  name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.issuer.name }}
+  namespace: {{ include "node-readiness-controller.namespace" . }}
+  labels:
+    {{- include "node-readiness-controller.labels" . | nindent 4 }}
+spec:
+  selfSigned: {}
+{{- end }}