Bump Version to v0.0.77

[helm chart] Check api version availability instead of using legacy value

.VERSION

@@ -1 +1 @@
-version: v0.0.72
+version: v0.0.77

README.md

@@ -22,7 +22,6 @@ Reloader can watch changes in `ConfigMap` and `Secret` and do rolling upgrades o
 ## Compatibility
 
 Reloader is compatible with kubernetes >= 1.9
-The `apiVersion: rbac.authorization.k8s.io/v1beta1` is depreciated since kubernetes = 1.17. To run it with older versions, please use the chart parameter `reloader.legacy.rbac=true`
 
 ## How to use Reloader
 
@@ -192,26 +191,20 @@ namespace: reloader
 
 ### Helm Charts
 
-Alternatively if you have configured helm on your cluster, you can add reloader to helm from our public chart repository and deploy it via helm using below mentioned commands
+Alternatively if you have configured helm on your cluster, you can add reloader to helm from our public chart repository and deploy it via helm using below mentioned commands. Follow [this](docs/Helm2-to-Helm3.md) guide, in case you have trouble migrating reloader from Helm2 to Helm3
 
 ```bash
 helm repo add stakater https://stakater.github.io/stakater-charts
 
 helm repo update
 
-helm install stakater/reloader
-```
-
-**Note:** The latest verion of reloader is using `apiVersion: rbac.authorization.k8s.io/v1` for rbac. The `apiVersion: rbac.authorization.k8s.io/v1beta1` is depreciated since kubernetes = 1.17. To run it with older versions, please use below command.
-
-```bash
-helm install stakater/reloader --set reloader.legacy.rbac=true
+helm install stakater/reloader # For helm3 add --generate-name flag or set the release name
 ```
 
 **Note:** By default reloader watches in all namespaces. To watch in single namespace, please run following command. It will install reloader in `test` namespace which will only watch `Deployments`, `Daemonsets` and `Statefulsets` in `test` namespace.
 
 ```bash
-helm install stakater/reloader --set reloader.watchGlobally=false --namespace test
+helm install stakater/reloader --set reloader.watchGlobally=false --namespace test # For helm3 add --generate-name flag or set the release name
 ```
 
 Reloader can be configured to ignore the resources `secrets` and `configmaps` by using the following parameters of `values.yaml` file:
@@ -225,6 +218,8 @@ Reloader can be configured to ignore the resources `secrets` and `configmaps` by
 
 You can also set the log format of Reloader to json by setting `logFormat` to `json` in values.yaml and apply the chart
 
+You can enable to scrape Reloader's Prometheus metrics by setting `serviceMonitor.enabled`  to `true` in values.yaml file.
+
 ## Help
 
 ### Documentation

build/package/Dockerfile.run

@@ -8,4 +8,7 @@ COPY Reloader /bin/Reloader
 # On alpine 'nobody' has uid 65534
 USER 65534
 
+# Port for metrics and probes
+EXPOSE 9090
+
 ENTRYPOINT ["/bin/Reloader"]

deployments/kubernetes/chart/reloader/Chart.yaml

@@ -3,8 +3,8 @@
 apiVersion: v1
 name: reloader
 description: Reloader chart that runs on kubernetes
-version: v0.0.72
-appVersion: v0.0.72
+version: v0.0.77
+appVersion: v0.0.77
 keywords:
   - Reloader
   - kubernetes

deployments/kubernetes/chart/reloader/OWNERS

@@ -5,6 +5,7 @@ approvers:
 - waseem-h
 - rasheedamir
 - ahsan-storm
+- ahmedwaleedmalik
 reviewers:
 - faizanahmad055
 - kahootali
@@ -12,3 +13,4 @@ reviewers:
 - waseem-h
 - rasheedamir
 - ahsan-storm
+- ahmedwaleedmalik

deployments/kubernetes/chart/reloader/templates/_helpers.tpl

@@ -25,6 +25,7 @@ app: {{ template "reloader-fullname" . }}
 chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
 release: {{ .Release.Name | quote }}
 heritage: {{ .Release.Service | quote }}
+app.kubernetes.io/managed-by: {{ .Release.Service | quote }}
 {{- end -}}
 
 {{/*
@@ -37,3 +38,11 @@ Create the name of the service account to use
     {{ default "default" .Values.reloader.serviceAccount.name }}
 {{- end -}}
 {{- end -}}
+
+{{/*
+Create the annotations to support helm3
+*/}}
+{{- define "reloader-helm3.annotations" -}}
+meta.helm.sh/release-namespace: {{ .Release.Namespace | quote }}
+meta.helm.sh/release-name: {{ .Release.Name | quote }}
+{{- end -}}

deployments/kubernetes/chart/reloader/templates/clusterrole.yaml

@@ -1,11 +1,13 @@
 {{- if and .Values.reloader.watchGlobally (.Values.reloader.rbac.enabled) }}
-{{- if and .Values.reloader.legacy.rbac }}
-apiVersion: rbac.authorization.k8s.io/v1beta1
-{{ else }}
+{{- if  (.Capabilities.APIVersions.Has "rbac.authorization.k8s.io/v1") }}
 apiVersion: rbac.authorization.k8s.io/v1
+{{ else }}
+apiVersion: rbac.authorization.k8s.io/v1beta1
 {{- end }}
 kind: ClusterRole
 metadata:
+  annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
   labels:
 {{ include "reloader-labels.chart" . | indent 4 }}
 {{- if .Values.reloader.rbac.labels }}

deployments/kubernetes/chart/reloader/templates/clusterrolebinding.yaml

@@ -1,11 +1,13 @@
 {{- if and .Values.reloader.watchGlobally (.Values.reloader.rbac.enabled) }}
-{{- if and .Values.reloader.legacy.rbac }}
-apiVersion: rbac.authorization.k8s.io/v1beta1
-{{ else }}
+{{- if  (.Capabilities.APIVersions.Has "rbac.authorization.k8s.io/v1") }}
 apiVersion: rbac.authorization.k8s.io/v1
+{{ else }}
+apiVersion: rbac.authorization.k8s.io/v1beta1
 {{- end }}
 kind: ClusterRoleBinding
 metadata:
+  annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
   labels:
 {{ include "reloader-labels.chart" . | indent 4 }}
 {{- if .Values.reloader.rbac.labels }}

deployments/kubernetes/chart/reloader/templates/deployment.yaml

@@ -1,8 +1,9 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-{{- if .Values.reloader.deployment.annotations }}
   annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
+{{- if .Values.reloader.deployment.annotations }}
 {{ toYaml .Values.reloader.deployment.annotations | indent 4 }}
 {{- end }}
   labels:
@@ -88,6 +89,19 @@ spec:
               fieldPath: metadata.namespace
       {{- end }}
       {{- end }}
+
+        ports:
+        - name: http
+          containerPort: 9090
+        livenessProbe:
+          httpGet:
+            path: /metrics
+            port: http
+        readinessProbe:
+          httpGet:
+            path: /metrics
+            port: http
+
       {{- if eq .Values.reloader.readOnlyRootFileSystem true }}
         volumeMounts:
           - mountPath: /tmp/

deployments/kubernetes/chart/reloader/templates/role.yaml

@@ -1,11 +1,13 @@
 {{- if and (not (.Values.reloader.watchGlobally)) (.Values.reloader.rbac.enabled) }}
-{{- if and .Values.reloader.legacy.rbac }}
-apiVersion: rbac.authorization.k8s.io/v1beta1
-{{ else }}
+{{- if  (.Capabilities.APIVersions.Has "rbac.authorization.k8s.io/v1") }}
 apiVersion: rbac.authorization.k8s.io/v1
+{{ else }}
+apiVersion: rbac.authorization.k8s.io/v1beta1
 {{- end }}
 kind: Role
 metadata:
+  annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
   labels:
 {{ include "reloader-labels.chart" . | indent 4 }}
 {{- if .Values.reloader.rbac.labels }}

deployments/kubernetes/chart/reloader/templates/rolebinding.yaml

@@ -1,12 +1,14 @@
 {{- if and (not (.Values.reloader.watchGlobally)) (.Values.reloader.rbac.enabled) }}
-{{- if and .Values.reloader.legacy.rbac }}
-apiVersion: rbac.authorization.k8s.io/v1beta1
-{{ else }}
+{{- if  (.Capabilities.APIVersions.Has "rbac.authorization.k8s.io/v1") }}
 apiVersion: rbac.authorization.k8s.io/v1
+{{ else }}
+apiVersion: rbac.authorization.k8s.io/v1beta1
 {{- end }}
 kind: RoleBinding
 metadata:
-  labels: 
+  annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
+  labels:
 {{ include "reloader-labels.chart" . | indent 4 }}
 {{- if .Values.reloader.rbac.labels }}
 {{ toYaml .Values.reloader.rbac.labels | indent 4 }}

deployments/kubernetes/chart/reloader/templates/service.yaml

@@ -2,8 +2,9 @@
 apiVersion: v1
 kind: Service
 metadata:
-{{- if .Values.reloader.service.annotations }}
   annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
+{{- if .Values.reloader.service.annotations }}
 {{ toYaml .Values.reloader.service.annotations | indent 4 }}
 {{- end }}
   labels:
@@ -21,5 +22,8 @@ spec:
 {{ toYaml .Values.reloader.matchLabels | indent 4 }}
 {{- end }}
   ports:
-{{ toYaml .Values.reloader.service.ports | indent 4 }}
-{{- end }}
+  - port: {{ .Values.reloader.service.port }}
+    name: http
+    protocol: TCP
+    targetPort: http
+{{- end }}

deployments/kubernetes/chart/reloader/templates/serviceaccount.yaml

@@ -5,6 +5,8 @@ kind: ServiceAccount
 imagePullSecrets: {{ toYaml .Values.global.imagePullSecrets | nindent 2 }}
 {{- end }}
 metadata:
+  annotations:
+{{ include "reloader-helm3.annotations" . | indent 4 }}
   labels:
 {{ include "reloader-labels.chart" . | indent 4 }}
 {{- if .Values.reloader.serviceAccount.labels }}

deployments/kubernetes/chart/reloader/templates/servicemonitor.yaml

@@ -0,0 +1,31 @@
+{{- if and ( .Capabilities.APIVersions.Has "monitoring.coreos.com/v1" ) ( .Values.reloader.serviceMonitor.enabled ) }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  labels:
+{{ include "reloader-labels.chart" . | indent 4 }}
+{{- if .Values.reloader.serviceMonitor.labels }}
+{{ toYaml .Values.reloader.serviceMonitor.labels | indent 4}}
+{{- end }}
+  name: {{ template "reloader-fullname" . }}
+{{- if .Values.reloader.serviceMonitor.namespace }}
+  namespace: {{ .Values.reloader.serviceMonitor.namespace }}
+{{- end }}
+spec:
+  endpoints:
+  - targetPort: http
+    path: "/metrics"
+{{- if .Values.reloader.serviceMonitor.interval }}
+    interval: {{ .Values.reloader.serviceMonitor.interval }}
+{{- end }}
+{{- if .Values.reloader.serviceMonitor.timeout }}
+    scrapeTimeout: {{ .Values.reloader.serviceMonitor.timeout }}
+{{- end }}
+  jobLabel: {{ template "reloader-fullname" . }}
+  namespaceSelector:
+    matchNames:
+    - {{ .Release.Namespace }}
+  selector:
+    matchLabels:
+      {{ include "reloader-labels.chart" . | nindent 6 }}
+{{- end }}

deployments/kubernetes/chart/reloader/values.yaml

@@ -51,10 +51,10 @@ reloader:
     labels:
       provider: stakater
       group: com.stakater.platform
-      version: v0.0.72
+      version: v0.0.77
     image:
       name: stakater/reloader
-      tag: "v0.0.72"
+      tag: "v0.0.77"
       pullPolicy: IfNotPresent
     # Support for extra environment variables.
     env:
@@ -81,11 +81,7 @@ reloader:
   service: {}
     # labels: {}
     # annotations: {}
-    # ports:
-    # - port: 9090
-    #   name: http
-    #   protocol: TCP
-    #   targetPort: 9090
+    # port: 9090
 
   rbac:
     enabled: true
@@ -104,3 +100,15 @@ reloader:
   #     configmap: "my.company.com/configmap"
   #     secret: "my.company.com/secret"
   custom_annotations: {}
+  serviceMonitor:
+    # enabling this requires service to be enabled as well, or no endpoints will be found
+    enabled: false
+    # Set the namespace the ServiceMonitor should be deployed
+    # namespace: monitoring
+    # Set how frequently Prometheus should scrape
+    # interval: 30s
+    # Set labels for the ServiceMonitor, use this to define your scrape label for Prometheus Operator
+    # labels:
+    # Set timeout for scrape
+    # timeout: 10s
+  

deployments/kubernetes/manifests/clusterrole.yaml

@@ -1,14 +1,18 @@
 ---
 # Source: reloader/templates/clusterrole.yaml
 
-apiVersion: rbac.authorization.k8s.io/v1
+apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: ClusterRole
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader-role
   namespace: default
 rules:

deployments/kubernetes/manifests/clusterrolebinding.yaml

@@ -1,14 +1,18 @@
 ---
 # Source: reloader/templates/clusterrolebinding.yaml
 
-apiVersion: rbac.authorization.k8s.io/v1
+apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: ClusterRoleBinding
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader-role-binding
   namespace: default
 roleRef:

deployments/kubernetes/manifests/deployment.yaml

@@ -3,14 +3,18 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
     group: com.stakater.platform
     provider: stakater
-    version: v0.0.72
+    version: v0.0.77
     
   name: reloader-reloader
 spec:
@@ -24,18 +28,31 @@ spec:
     metadata:
       labels:
         app: reloader-reloader
-        chart: "reloader-v0.0.72"
+        chart: "reloader-v0.0.77"
         release: "reloader"
         heritage: "Tiller"
+        app.kubernetes.io/managed-by: "Tiller"
         group: com.stakater.platform
         provider: stakater
-        version: v0.0.72
+        version: v0.0.77
         
     spec:
       containers:
-      - image: "stakater/reloader:v0.0.72"
+      - image: "stakater/reloader:v0.0.77"
         imagePullPolicy: IfNotPresent
         name: reloader-reloader
+
+        ports:
+        - name: http
+          containerPort: 9090
+        livenessProbe:
+          httpGet:
+            path: /metrics
+            port: http
+        readinessProbe:
+          httpGet:
+            path: /metrics
+            port: http
       securityContext: 
         runAsNonRoot: true
         runAsUser: 65534

deployments/kubernetes/manifests/service.yaml

@@ -1,3 +1,4 @@
 ---
 # Source: reloader/templates/service.yaml
 
+

deployments/kubernetes/manifests/serviceaccount.yaml

@@ -4,10 +4,14 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader
 

deployments/kubernetes/manifests/servicemonitor.yaml

@@ -0,0 +1,4 @@
+---
+# Source: reloader/templates/servicemonitor.yaml
+
+

deployments/kubernetes/reloader.yaml

@@ -1,14 +1,18 @@
 ---
 # Source: reloader/templates/clusterrole.yaml
 
-apiVersion: rbac.authorization.k8s.io/v1
+apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: ClusterRole
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader-role
   namespace: default
 rules:
@@ -46,14 +50,18 @@ rules:
 ---
 # Source: reloader/templates/clusterrolebinding.yaml
 
-apiVersion: rbac.authorization.k8s.io/v1
+apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: ClusterRoleBinding
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader-role-binding
   namespace: default
 roleRef:
@@ -70,14 +78,18 @@ subjects:
 apiVersion: apps/v1
 kind: Deployment
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
     group: com.stakater.platform
     provider: stakater
-    version: v0.0.72
+    version: v0.0.77
     
   name: reloader-reloader
 spec:
@@ -91,18 +103,31 @@ spec:
     metadata:
       labels:
         app: reloader-reloader
-        chart: "reloader-v0.0.72"
+        chart: "reloader-v0.0.77"
         release: "reloader"
         heritage: "Tiller"
+        app.kubernetes.io/managed-by: "Tiller"
         group: com.stakater.platform
         provider: stakater
-        version: v0.0.72
+        version: v0.0.77
         
     spec:
       containers:
-      - image: "stakater/reloader:v0.0.72"
+      - image: "stakater/reloader:v0.0.77"
         imagePullPolicy: IfNotPresent
         name: reloader-reloader
+
+        ports:
+        - name: http
+          containerPort: 9090
+        livenessProbe:
+          httpGet:
+            path: /metrics
+            port: http
+        readinessProbe:
+          httpGet:
+            path: /metrics
+            port: http
       securityContext: 
         runAsNonRoot: true
         runAsUser: 65534
@@ -120,16 +145,25 @@ spec:
 ---
 # Source: reloader/templates/service.yaml
 
+
 ---
 # Source: reloader/templates/serviceaccount.yaml
 
 apiVersion: v1
 kind: ServiceAccount
 metadata:
+  annotations:
+    meta.helm.sh/release-namespace: "default"
+    meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-v0.0.72"
+    chart: "reloader-v0.0.77"
     release: "reloader"
     heritage: "Tiller"
+    app.kubernetes.io/managed-by: "Tiller"
   name: reloader-reloader
 
+---
+# Source: reloader/templates/servicemonitor.yaml
+
+

deployments/kubernetes/templates/chart/values.yaml.tmpl

@@ -81,11 +81,7 @@ reloader:
   service: {}
     # labels: {}
     # annotations: {}
-    # ports:
-    # - port: 9090
-    #   name: http
-    #   protocol: TCP
-    #   targetPort: 9090
+    # port: 9090
 
   rbac:
     enabled: true
@@ -104,3 +100,15 @@ reloader:
   #     configmap: "my.company.com/configmap"
   #     secret: "my.company.com/secret"
   custom_annotations: {}
+  serviceMonitor:
+    # enabling this requires service to be enabled as well, or no endpoints will be found
+    enabled: false
+    # Set the namespace the ServiceMonitor should be deployed
+    # namespace: monitoring
+    # Set how frequently Prometheus should scrape
+    # interval: 30s
+    # Set labels for the ServiceMonitor, use this to define your scrape label for Prometheus Operator
+    # labels:
+    # Set timeout for scrape
+    # timeout: 10s
+  

docs/Helm2-to-Helm3.md

@@ -0,0 +1,62 @@
+# Helm2 to Helm3 Migration
+
+Follow below mentioned instructions to migrate reloader from Helm2 to Helm3
+
+## Instrcutions:
+
+There are 3 steps involved in migrating the reloader from Helm2 to Helm3.
+
+### Step 1:
+Install the helm-2to3 plugin
+
+```bash
+helm3 plugin install https://github.com/helm/helm-2to3
+
+helm3 2to3 convert <release-name>
+
+helm3 2to3 cleanup --release-cleanup --skip-confirmation
+```
+
+### Step 2:
+Add the following Helm3 labels and annotations on reloader resources.
+
+Label:
+
+```yaml
+app.kubernetes.io/managed-by=Helm
+```
+Annotations:
+```yaml
+meta.helm.sh/release-name=<release-name>
+meta.helm.sh/release-namespace=<namespace>
+```
+
+For example, to label and annotate the ClusterRoleBinding and ClusterRole:
+
+```bash
+KIND=ClusterRoleBinding
+NAME=reloader-reloader-role-binding
+RELEASE=reloader
+NAMESPACE=kube-system
+kubectl annotate $KIND $NAME meta.helm.sh/release-name=$RELEASE
+kubectl annotate $KIND $NAME meta.helm.sh/release-namespace=$NAMESPACE
+kubectl label $KIND $NAME app.kubernetes.io/managed-by=Helm
+
+KIND=ClusterRole
+NAME=reloader-reloader-role
+RELEASE=reloader
+NAMESPACE=kube-system
+kubectl annotate $KIND $NAME meta.helm.sh/release-name=$RELEASE
+kubectl annotate $KIND $NAME meta.helm.sh/release-namespace=$NAMESPACE
+kubectl label $KIND $NAME app.kubernetes.io/managed-by=Helm
+```
+
+### Step 3:
+Upgrade to desired version
+```bash
+helm3 repo add stakater https://stakater.github.io/stakater-charts
+
+helm3 repo update
+
+helm3 upgrade <release-name> stakater/reloader --version=v0.0.72
+```

internal/pkg/controller/controller.go

@@ -57,12 +57,8 @@ func NewController(
 
 // Add function to add a new object to the queue in case of creating a resource
 func (c *Controller) Add(obj interface{}) {
-	if !c.resourceInIgnoredNamespace(obj) {
-		c.queue.Add(handler.ResourceCreatedHandler{
-			Resource:   obj,
-			Collectors: c.collectors,
-		})
-	}
+	// Not required as reloader should update the resource in the event of any change and not in the event of any resource creation.
+	// This causes the issue where reloader reloads the pods when reloader itself gets restarted as it's queue is filled with all the k8s objects as new resources.
 }
 
 func (c *Controller) resourceInIgnoredNamespace(raw interface{}) bool {