Skip to content

Commit d75ea74

Browse files
Priyankasaggu11929Priyankasaggu11929
authored
rename Helm chart from nrr-controller to node-readiness-controller (#407)
1 parent 7477e9f commit d75ea74

28 files changed

Lines changed: 159 additions & 159 deletions

‎.github/workflows/helm.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
6161
- name: Run Helm Unit Tests
6262
run: |
63-
helm unittest charts/nrr-controller --strict -d
63+
helm unittest charts/node-readiness-controller --strict -d
6464
6565
- name: Run chart-testing (list-changed)
6666
id: list-changed

‎Makefile‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -490,17 +490,17 @@ crd-ref-docs:
490490
HELM ?= go run helm.sh/helm/v3/cmd/helm@v3.15.1
491491

492492
lint-chart:
493-
$(HELM) lint ./charts/nrr-controller
493+
$(HELM) lint ./charts/node-readiness-controller
494494

495495
inject-helm-version: ## Inject the release version into the Helm chart's appVersion and image tag
496-
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
497-
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
496+
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
497+
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
498498

499499
build-helm: inject-helm-version
500-
$(HELM) package ./charts/nrr-controller --dependency-update --destination ./bin/chart
500+
$(HELM) package ./charts/node-readiness-controller --dependency-update --destination ./bin/chart
501501

502502
publish-helm: ## Publish the packaged Helm chart to an OCI registry
503-
$(HELM) push ./bin/chart/nrr-controller-*.tgz oci://$(HELM_IMAGE)
503+
$(HELM) push ./bin/chart/node-readiness-controller-*.tgz oci://$(HELM_IMAGE)
504504

505505
kind-multi-node:
506506
kind create cluster --name $(KIND_CLUSTER) --config ./config/testing/kind/kind-3node-config.yaml --wait 2m

‎RELEASE.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ After the release tag is pushed, the images and Helm chart must be built, pushed
3434
```sh
3535
skopeo list-tags docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/node-readiness-controller | grep vX.Y.Z
3636
```
37-
- Verify the chart exists in the staging repository (replace `<chart-version>` with the version in `charts/nrr-controller/Chart.yaml` at the tagged commit):
37+
- 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):
3838
```sh
39-
helm pull oci://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/nrr-controller --version <chart-version>
39+
helm pull oci://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/node-readiness-controller --version <chart-version>
4040
```
4141

4242
### B. Create PR for Promotion
@@ -47,7 +47,7 @@ After the release tag is pushed, the images and Helm chart must be built, pushed
4747
```
4848
- Identify the chart digest:
4949
```sh
50-
skopeo inspect --raw docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/nrr-controller:<chart-version> | sha256sum
50+
skopeo inspect --raw docker://us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller/charts/node-readiness-controller:<chart-version> | sha256sum
5151
```
5252
Alternatively, note the digest printed by `helm push`/`helm pull` when the chart was published/verified above.
5353
- 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-
6868
```
6969
- Ensure the chart is available at `registry.k8s.io`:
7070
```sh
71-
helm pull oci://registry.k8s.io/node-readiness-controller/charts/nrr-controller --version <chart-version>
71+
helm pull oci://registry.k8s.io/node-readiness-controller/charts/node-readiness-controller --version <chart-version>
7272
```
7373

7474
### B. Test Release Artifacts

charts/nrr-controller/.helmignore renamed to charts/node-readiness-controller/.helmignore

File renamed without changes.

charts/nrr-controller/Chart.yaml renamed to charts/node-readiness-controller/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
apiVersion: v2
2-
name: nrr-controller
2+
name: node-readiness-controller
33
description: A Helm chart for the Node Readiness Controller
44
type: application
55
version: 0.1.0

charts/nrr-controller/README.md renamed to charts/node-readiness-controller/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
```shell
88
git clone https://github.com/kubernetes-sigs/node-readiness-controller.git
99
cd node-readiness-controller
10-
helm install my-release --namespace nrr-system --create-namespace ./charts/nrr-controller
10+
helm install my-release --namespace nrr-system --create-namespace ./charts/node-readiness-controller
1111
```
1212

1313
> 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
2525
To install the chart with the release name `my-release`:
2626

2727
```shell
28-
helm install --namespace nrr-system --create-namespace my-release ./charts/nrr-controller
28+
helm install --namespace nrr-system --create-namespace my-release ./charts/node-readiness-controller
2929
```
3030

3131
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
3434
3535
## CRD Upgrades
3636

37-
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`.
37+
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`.
3838

3939
## Uninstalling the Chart
4040

@@ -56,8 +56,8 @@ The following table lists the configurable parameters of the _node-readiness-con
5656
| `image.tag` | Docker tag to use | `v[chart appVersion]` |
5757
| `image.pullPolicy` | Docker image pull policy | `IfNotPresent` |
5858
| `imagePullSecrets` | Docker repository secrets | `[]` |
59-
| `nameOverride` | String to partially override `nrr-controller.fullname` template (will prepend the release name) | `""` |
60-
| `fullnameOverride` | String to fully override `nrr-controller.fullname` template | `""` |
59+
| `nameOverride` | String to partially override `node-readiness-controller.fullname` template (will prepend the release name) | `""` |
60+
| `fullnameOverride` | String to fully override `node-readiness-controller.fullname` template | `""` |
6161
| `namespaceOverride` | Override the deployment namespace; defaults to .Release.Namespace | `""` |
6262
| `replicaCount` | The replica count for Deployment | `1` |
6363
| `controller.kubeAPIQPS` | Maximum QPS to the Kubernetes API server. `-1` means no limit. | `-1` |

charts/nrr-controller/crds/nodereadinessrules.readiness.node.x-k8s.io.yaml renamed to charts/node-readiness-controller/crds/nodereadinessrules.readiness.node.x-k8s.io.yaml

File renamed without changes.

charts/nrr-controller/templates/_helpers.tpl renamed to charts/node-readiness-controller/templates/_helpers.tpl

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{{/*
33
Expand the name of the chart.
44
*/}}
5-
{{- define "nrr-controller.name" -}}
5+
{{- define "node-readiness-controller.name" -}}
66
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
77
{{- end -}}
88

@@ -11,11 +11,11 @@ Create a default fully qualified app name.
1111
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
1212
If release name contains chart name it will be used as a full name.
1313
*/}}
14-
{{- define "nrr-controller.fullname" -}}
14+
{{- define "node-readiness-controller.fullname" -}}
1515
{{- if .Values.fullnameOverride -}}
1616
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
1717
{{- else -}}
18-
{{- $name := include "nrr-controller.name" . -}}
18+
{{- $name := include "node-readiness-controller.name" . -}}
1919
{{- if contains $name .Release.Name -}}
2020
{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
2121
{{- else -}}
@@ -28,23 +28,23 @@ If release name contains chart name it will be used as a full name.
2828
Expand the namespace of the release.
2929
Allows overriding it for multi-namespace deployments in combined charts.
3030
*/}}
31-
{{- define "nrr-controller.namespace" -}}
31+
{{- define "node-readiness-controller.namespace" -}}
3232
{{- default .Release.Namespace .Values.namespaceOverride | trunc 63 | trimSuffix "-" -}}
3333
{{- end -}}
3434

3535
{{/*
3636
Create chart name and version as used by the chart label.
3737
*/}}
38-
{{- define "nrr-controller.chart" -}}
38+
{{- define "node-readiness-controller.chart" -}}
3939
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
4040
{{- end -}}
4141

4242
{{/*
4343
Common labels
4444
*/}}
45-
{{- define "nrr-controller.labels" -}}
46-
app.kubernetes.io/name: {{ include "nrr-controller.name" . }}
47-
helm.sh/chart: {{ include "nrr-controller.chart" . }}
45+
{{- define "node-readiness-controller.labels" -}}
46+
app.kubernetes.io/name: {{ include "node-readiness-controller.name" . }}
47+
helm.sh/chart: {{ include "node-readiness-controller.chart" . }}
4848
app.kubernetes.io/instance: {{ .Release.Name }}
4949
{{- if .Chart.AppVersion }}
5050
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
@@ -58,18 +58,18 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
5858
{{/*
5959
Selector labels
6060
*/}}
61-
{{- define "nrr-controller.selectorLabels" -}}
62-
app.kubernetes.io/name: {{ include "nrr-controller.name" . }}
61+
{{- define "node-readiness-controller.selectorLabels" -}}
62+
app.kubernetes.io/name: {{ include "node-readiness-controller.name" . }}
6363
app.kubernetes.io/instance: {{ .Release.Name }}
6464
control-plane: controller-manager
6565
{{- end -}}
6666

6767
{{/*
6868
Create the name of the service account to use
6969
*/}}
70-
{{- define "nrr-controller.serviceAccountName" -}}
70+
{{- define "node-readiness-controller.serviceAccountName" -}}
7171
{{- if .Values.serviceAccount.create -}}
72-
{{ default (include "nrr-controller.fullname" .) .Values.serviceAccount.name }}
72+
{{ default (include "node-readiness-controller.fullname" .) .Values.serviceAccount.name }}
7373
{{- else -}}
7474
{{ default "default" .Values.serviceAccount.name }}
7575
{{- end -}}

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{{- if and .Values.certManager.enabled .Values.certManager.metricsCertificate.create .Values.metrics.enabled .Values.metrics.secure }}
2+
---
3+
apiVersion: cert-manager.io/v1
4+
kind: Certificate
5+
metadata:
6+
name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.metricsCertificate.name }}
7+
namespace: {{ include "node-readiness-controller.namespace" . }}
8+
labels:
9+
{{- include "node-readiness-controller.labels" . | nindent 4 }}
10+
spec:
11+
secretName: {{ .Values.metrics.certSecretName }}
12+
{{- with .Values.certManager.certificateSubject }}
13+
subject:
14+
{{- toYaml . | nindent 4 }}
15+
{{- end }}
16+
dnsNames:
17+
- {{ include "node-readiness-controller.fullname" . }}-metrics-service.{{ include "node-readiness-controller.namespace" . }}.svc
18+
- {{ include "node-readiness-controller.fullname" . }}-metrics-service.{{ include "node-readiness-controller.namespace" . }}.svc.cluster.local
19+
issuerRef:
20+
kind: Issuer
21+
name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.issuer.name }}
22+
{{- end }}
23+
{{- if and .Values.certManager.enabled .Values.webhook.enabled .Values.certManager.webhookCertificate.create }}
24+
---
25+
apiVersion: cert-manager.io/v1
26+
kind: Certificate
27+
metadata:
28+
name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.webhookCertificate.name }}
29+
namespace: {{ include "node-readiness-controller.namespace" . }}
30+
labels:
31+
{{- include "node-readiness-controller.labels" . | nindent 4 }}
32+
spec:
33+
secretName: {{ .Values.webhook.certSecretName }}
34+
{{- with .Values.certManager.certificateSubject }}
35+
subject:
36+
{{- toYaml . | nindent 4 }}
37+
{{- end }}
38+
dnsNames:
39+
- {{ include "node-readiness-controller.fullname" . }}-webhook-service.{{ include "node-readiness-controller.namespace" . }}.svc
40+
- {{ include "node-readiness-controller.fullname" . }}-webhook-service.{{ include "node-readiness-controller.namespace" . }}.svc.cluster.local
41+
issuerRef:
42+
kind: Issuer
43+
name: {{ include "node-readiness-controller.fullname" . }}-{{ .Values.certManager.issuer.name }}
44+
{{- end }}

charts/nrr-controller/templates/deployment.yaml renamed to charts/node-readiness-controller/templates/deployment.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
apiVersion: apps/v1
22
kind: Deployment
33
metadata:
4-
name: {{ include "nrr-controller.fullname" . }}-manager
5-
namespace: {{ include "nrr-controller.namespace" . }}
4+
name: {{ include "node-readiness-controller.fullname" . }}-manager
5+
namespace: {{ include "node-readiness-controller.namespace" . }}
66
labels:
7-
{{- include "nrr-controller.labels" . | nindent 4 }}
7+
{{- include "node-readiness-controller.labels" . | nindent 4 }}
88
spec:
99
replicas: {{ .Values.replicaCount }}
1010
selector:
1111
matchLabels:
12-
{{- include "nrr-controller.selectorLabels" . | nindent 6 }}
12+
{{- include "node-readiness-controller.selectorLabels" . | nindent 6 }}
1313
template:
1414
metadata:
1515
annotations:
1616
{{- if .Values.podAnnotations }}
1717
{{- .Values.podAnnotations | toYaml | nindent 10 }}
1818
{{- end }}
1919
labels:
20-
{{- include "nrr-controller.selectorLabels" . | nindent 8 }}
20+
{{- include "node-readiness-controller.selectorLabels" . | nindent 8 }}
2121
{{- with .Values.podLabels }}
2222
{{- toYaml . | nindent 8 }}
2323
{{- end }}
2424
spec:
25-
serviceAccountName: {{ include "nrr-controller.serviceAccountName" . }}
25+
serviceAccountName: {{ include "node-readiness-controller.serviceAccountName" . }}
2626
{{- with .Values.imagePullSecrets }}
2727
imagePullSecrets:
2828
{{- toYaml . | nindent 8 }}

0 commit comments

Comments
 (0)