Bump Version to 0.0.17

Update readme about how to define multiple configmaps and secrets

.version

@@ -1 +1 @@
-0.0.3
+0.0.17

Jenkinsfile

@@ -1,5 +1,5 @@
 #!/usr/bin/groovy
-@Library('github.com/stakater/fabric8-pipeline-library@v2.5.2')
+@Library('github.com/stakater/fabric8-pipeline-library@v2.7.2')
 
 def dummy
 

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,80 +1,102 @@
-# RELOADER
+# ![](assets/web/reloader-round-100px.png) RELOADER
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/stakater/reloader?style=flat-square)](https://goreportcard.com/report/github.com/stakater/reloader)
+[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/stakater/reloader)
+[![Release](https://img.shields.io/github/release/stakater/reloader.svg?style=flat-square)](https://github.com/stakater/reloader/releases/latest)
+[![GitHub tag](https://img.shields.io/github/tag/stakater/reloader.svg?style=flat-square)](https://github.com/stakater/reloader/releases/latest)
+[![Docker Pulls](https://img.shields.io/docker/pulls/stakater/reloader.svg?style=flat-square)](https://hub.docker.com/r/stakater/reloader/)
+[![Docker Stars](https://img.shields.io/docker/stars/stakater/reloader.svg?style=flat-square)](https://hub.docker.com/r/stakater/reloader/)
+[![MicroBadger Size](https://img.shields.io/microbadger/image-size/stakater/reloader.svg?style=flat-square)](https://microbadger.com/images/stakater/reloader)
+[![MicroBadger Layers](https://img.shields.io/microbadger/layers/stakater/reloader.svg?style=flat-square)](https://microbadger.com/images/stakater/reloader)
+[![license](https://img.shields.io/github/license/stakater/reloader.svg?style=flat-square)](LICENSE)
+[![Get started with Stakater](https://stakater.github.io/README/stakater-github-banner.png)](http://stakater.com/?utm_source=Reloader&utm_medium=github)
 
 ## Problem
 
-We would like to watch if some change happens in `ConfigMap` and `Secret` objects and then perform certain upgrade on relevant `Deployment`, `Deamonset` and `Statefulset`
+We would like to watch if some change happens in `ConfigMap` and/or `Secret`; then perform a rolling upgrade on relevant `Deployment`, `Deamonset` and `Statefulset`
 
 ## Solution
 
-Reloader can watch any changes in `ConfigMap` and `Secret` objects and update or recreate Pods for their associated `Deployments`, `Deamonsets` and `Statefulsets`. In this way Pods can get the latest changes in `ConfigMap` or `Secret` objects.
-
-**NOTE:** This controller has been inspired from [configmapController](https://github.com/fabric8io/configmapcontroller)
+Reloader can watch changes in `ConfigMap` and `Secret` and do rolling upgrades on Pods with their associated `Deployments`, `Deamonsets` and `Statefulsets`.
 
 ## How to use Reloader
 
-For a `Deployment` called `foo` have a `ConfigMap` called `foo`. Then add this annotation to your `Deployment`
+### Configmap
+
+For a `Deployment` called `foo` have a `ConfigMap` called `foo-configmap`. Then add this annotation to your `Deployment`
 
 ```yaml
 metadata:
   annotations:
-    configmap.reloader.stakater.com/reload: "foo"
+    configmap.reloader.stakater.com/reload: "foo-configmap"
 ```
 
-OR
-
-For a `Deployment` called `foo` have a `Secret` called `foo`. Then add this annotation to your `Deployment`
+Use comma separated list to define multiple configmaps.
 
 ```yaml
 metadata:
   annotations:
-    secret.reloader.stakater.com/reload: "foo"
+    configmap.reloader.stakater.com/reload: "foo-configmap,bar-configmap,baz-configmap"
 ```
 
-Then, providing `Reloader` is running, whenever you edit the `ConfigMap` or `Secret` called `foo` the Reloader will update the `Deployment` by adding the environment variable:
+### Secret
 
-```
-STAKATER_FOO_REVISION=${reloaderRevision}
+For a `Deployment` called `foo` have a `Secret` called `foo-secret`. Then add this annotation to your `Deployment`
+
+```yaml
+metadata:
+  annotations:
+    secret.reloader.stakater.com/reload: "foo-secret"
 ```
 
-This then triggers a rolling upgrade of your deployment's pods to use the new configuration.
+Use comma separated list to define multiple secrets.
 
-Same procedure can be followed to perform rolling upgrade on `Deamonsets` and `Statefulsets` as well.
+```yaml
+metadata:
+  annotations:
+    secret.reloader.stakater.com/reload: "foo-secret,bar-secret,baz-secret"
+```
 
 ## Deploying to Kubernetes
 
-You can deploy Reloader by running the following kubectl commands:
-
-```bash
-kubectl apply -f rbac.yaml -n <namespace>
-kubectl apply -f deployment.yaml -n <namespace>
-```
+You can deploy Reloader by following methods:
 
 ### Vanilla Manifests
 
 You can apply vanilla manifests by running the following command
 
 ```bash
-kubecl apply -f https://raw.githubusercontent.com/stakater/Reloader/master/deployments/kubernetes/reloader.yaml
+kubectl apply -f https://raw.githubusercontent.com/stakater/Reloader/master/deployments/kubernetes/reloader.yaml
 ```
 
+By default Reloader gets deployed in `default` namespace and watches changes `secrets` and `configmaps` in all namespaces.
+
 ### Helm Charts
 
-Or alternatively if you configured `helm` on your cluster, you can deploy Reloader via helm chart located under `deployments/kubernetes/chart/reloader` folder.
+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
 
-### Monitor All namespaces
-You can monitor all namespaces in cluster by setting the `watchGlobally` flag to `true` in manifest file.
+ ```bash
+helm repo add stakater https://stakater.github.io/stakater-charts
+
+helm repo update
+
+helm install stakater/reloader
+```
 
 ## Help
 
-**Got a question?**
+### Documentation
+You can find more documentation [here](docs/)
+
+### Have a question?
 File a GitHub [issue](https://github.com/stakater/Reloader/issues), or send us an [email](mailto:stakater@gmail.com).
 
 ### Talk to us on Slack
 
-Join and talk to us on the #tools-imc channel for discussing Reloader
+Join and talk to us on Slack for discussing Reloader
 
 [![Join Slack](https://stakater.github.io/README/stakater-join-slack-btn.png)](https://stakater-slack.herokuapp.com/)
-[![Chat](https://stakater.github.io/README/stakater-chat-btn.png)](https://stakater.slack.com/messages/CAN960CTG/)
+[![Chat](https://stakater.github.io/README/stakater-chat-btn.png)](https://stakater.slack.com/)
 
 ## Contributing
 
@@ -111,3 +133,7 @@ or contact us in case of professional services and queries on <hello@stakater.co
 
   [website]: http://stakater.com/
   [community]: https://github.com/stakater/
+
+## Acknowledgements
+
+- [ConfigmapController](https://github.com/fabric8io/configmapcontroller); We documented here why we re-created [Reloader](docs/Reloader-vs-ConfigmapController.md)

deployments/kubernetes/chart/reloader/Chart.yaml

@@ -3,7 +3,7 @@
 apiVersion: v1
 name: reloader
 description: Reloader chart that runs on kubernetes
-version: 0.0.3
+version: 0.0.17
 keywords:
   - Reloader
   - kubernetes

deployments/kubernetes/chart/reloader/values.yaml

@@ -7,9 +7,9 @@ reloader:
   labels:
     provider: stakater
     group: com.stakater.platform
-    version: 0.0.3
+    version: 0.0.17
   image:
     name: stakater/reloader
-    tag: "0.0.3"
+    tag: "0.0.17"
     pullPolicy: IfNotPresent
-  watchGlobally: false
+  watchGlobally: true

deployments/kubernetes/manifests/deployment.yaml

@@ -7,8 +7,8 @@ metadata:
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader
@@ -29,11 +29,7 @@ spec:
     spec:
       containers:
       - env:
-        - name: KUBERNETES_NAMESPACE
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.namespace
-        image: "stakater/reloader:0.0.3"
+        image: "stakater/reloader:0.0.17"
         imagePullPolicy: IfNotPresent
         name: reloader
       serviceAccountName: reloader

deployments/kubernetes/manifests/rbac.yaml

@@ -7,25 +7,25 @@ metadata:
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: Role
+kind: ClusterRole
 metadata:
   labels: 
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader-role
-  namespace: tools
+  namespace: default
 rules:
   - apiGroups:
       - ""
@@ -51,23 +51,23 @@ rules:
       - patch
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: RoleBinding
+kind: ClusterRoleBinding
 metadata:
   labels: 
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader-role-binding
-  namespace: tools
+  namespace: default
 roleRef:
   apiGroup: rbac.authorization.k8s.io
-  kind: Role
+  kind: ClusterRole
   name: reloader-role
 subjects:
   - kind: ServiceAccount
     name: reloader
-    namespace: tools
+    namespace: default

deployments/kubernetes/reloader.yaml

@@ -7,8 +7,8 @@ metadata:
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader
@@ -29,11 +29,7 @@ spec:
     spec:
       containers:
       - env:
-        - name: KUBERNETES_NAMESPACE
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.namespace
-        image: "stakater/reloader:0.0.3"
+        image: "stakater/reloader:0.0.17"
         imagePullPolicy: IfNotPresent
         name: reloader
       serviceAccountName: reloader
@@ -47,25 +43,25 @@ metadata:
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: Role
+kind: ClusterRole
 metadata:
   labels: 
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader-role
-  namespace: tools
+  namespace: default
 rules:
   - apiGroups:
       - ""
@@ -91,23 +87,23 @@ rules:
       - patch
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: RoleBinding
+kind: ClusterRoleBinding
 metadata:
   labels: 
     app: reloader
     group: com.stakater.platform
     provider: stakater
-    version: 0.0.3
-    chart: "reloader-0.0.3"
+    version: 0.0.17
+    chart: "reloader-0.0.17"
     release: "RELEASE-NAME"
     heritage: "Tiller"
   name: reloader-role-binding
-  namespace: tools
+  namespace: default
 roleRef:
   apiGroup: rbac.authorization.k8s.io
-  kind: Role
+  kind: ClusterRole
   name: reloader-role
 subjects:
   - kind: ServiceAccount
     name: reloader
-    namespace: tools
+    namespace: default

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

@@ -12,4 +12,4 @@ reloader:
     name: {{ getenv "DOCKER_IMAGE" }}
     tag: "{{ getenv "VERSION" }}"
     pullPolicy: IfNotPresent
-  watchGlobally: false
+  watchGlobally: true

docs/How-it-works.md

@@ -0,0 +1,77 @@
+# How it works?
+
+Reloader watches for `ConfigMap` and `Secret` and detects if there are changes in data of these objects. After change detection reloader performs rolling upgrade on relevant Pods via associated `Deployment`, `Deamonset` and `Statefulset`.
+
+## How change detection works
+
+Reloader watches changes in `configmaps` and `secrets` data. As soon as it detects a change in these. It forwards these objects to an update handler which decides if and how to perform the rolling upgrade.
+
+## Requirements for rolling upgrade
+
+To perform rolling upgrade a `deployment`, `daemonset` or `statefulset` must have
+
+- support for rolling upgrade strategy
+- specific annotation for `configmaps` or `secrets`
+
+The annotation value is comma separated list of `configmaps` or `secrets`. If a change is detected in data of these `configmaps` or `secrets`, reloader will perform rolling upgrades on their associated `deployments`, `daemonsets` or `statefulsets`.
+
+### Annotation for Configmap
+
+For a `Deployment` called `foo` have a `ConfigMap` called `foo`. Then add this annotation to your `Deployment`
+
+```yaml
+metadata:
+  annotations:
+    configmap.reloader.stakater.com/reload: "foo"
+```
+
+### Annotation for Secret
+
+For a `Deployment` called `foo` have a `Secret` called `foo`. Then add this annotation to your `Deployment`
+
+```yaml
+metadata:
+  annotations:
+    secret.reloader.stakater.com/reload: "foo"
+```
+
+Above mentioned annotation are also work for `Daemonsets` and `Statefulsets`
+
+## How Rolling upgrade works?
+
+When reloader detects changes in configmap. It gets two objects of configmap. First object is an old configmap object which has a state before the latest change. Second object is new configmap object which contains latest changes. Reloader compares both objects and see whether any change in data occurred or not. If reloader finds any change in new configmap object, only then, it move forward with rolling upgrade.
+
+After that, reloader gets the list of all deployments, daemonsets and statefulset and looks for above mentioned annotation for configmap. If the annotation value contains the configmap name, it then looks for an environment variable which can contain the configmap or secret data change hash.
+
+### Environment variable for Configmap
+
+If configmap name is foo then
+
+```yaml
+STAKATER_FOO_CONFIGMAP
+```
+
+### Environment variable for Secret
+
+If Secret name is foo then
+
+```yaml
+STAKATER_FOO_SECRET
+```
+
+If the environment variable is found then it gets its value and compares it with new configmap hash value. If old value in environment variable is different from new hash value then reloader updates the environment variable. If the environment variable does not exist then it creates a new environment variable with latest hash value from configmap and updates the relevant `deployment`, `daemonset` or `statefulset`
+
+Note: Rolling upgrade also works in the same way for secrets.
+
+### Hash value Computation
+
+Reloader uses SHA1 to compute hash value. SHA1 is used because it is efficient and less prone to collision.
+
+## Monitor All Namespaces
+
+By default reloader deploys in default namespace and monitors changes in all namespaces. To monitor changes in a specific namespace deploy the reloader in that namespace and set the `watchGlobally` flag to `false` in values file located under `deployments/kubernetes/chart/reloader`
+And render manifest file using helm command
+```bash
+helm --namespace {replace this with namespace name} template . > reloader.yaml
+```
+The output file can then be used to deploy reloader in specific namespace.

docs/Reloader-vs-ConfigmapController.md

@@ -0,0 +1,11 @@
+
+# Reloader vs ConfigmapController
+
+Reloader is inspired from [Configmapcontroller](https://github.com/fabric8io/configmapcontroller) but there are many ways in which it differs from configmapController. Below is the small comparison between these two controllers.
+
+| Reloader                                                                                                                                                                                                                                                                                                                 | Configmap                                                                                                                                                                                                                                                          |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Reloader can watch both `secrets` and `configmaps`.                                                                                                                                                                                                                                                    | ConfigmapController can only watch changes in `configmaps`. It cannot detect changes in other resources like `secrets`.                                                                                                                                        |
+| Reloader can perform rolling upgrades on `deployments` as well as on `statefulsets` and `daemonsets`                                                                                                                                                                                                   | ConfigmapController can only perform rolling upgrades on `deployments`. It currently does not support rolling upgrades on `statefulsets` and `daemonsets`                                                                                                          |
+| Reloader provides both unit test cases and end to end integration test cases for future updates. So one can make sure that new changes do not break any old functionality.                                                                                                                                               | Currently there are not any unit test cases or end to end integration test cases in configmap controller. It add difficulties for any additional updates in configmap controller and one can not know for sure whether new changes breaks any old functionality or not. |
+| Reloader uses SHA1 to encode the change in configmap or secret. It then saves the SHA1 value in `STAKATER_FOO_CONFIGMAP` or `STAKATER_FOO_SECRET` environment variable depending upon where the change has happened. The use of SHA1 provides a concise 40 characters encoded value that is very less pron to collision. | Configmap controller uses `FABRICB_FOO_REVISION` environment variable to store any change in configmap controller. It does not encode it or convert it in suitable hash value to avoid data pollution in deployment.                                               |

docs/Reloader-vs-k8s-trigger-controller.md

@@ -0,0 +1,28 @@
+# Reloader vs k8s-trigger-controller
+
+Reloader and k8s-trigger-controller are both built for same purpose. So there are quite a few similarities and differences between these.
+
+## Similarities
+
+- Both controllers support change detection in configmap and secrets
+- Both controllers support deployment rollout
+- Both controllers use SHA1 for hashing
+- Both controllers have end to end as well as unit test cases.
+
+## Differences
+
+### Support for Daemonsets and Statefulsets.
+
+#### k8s-trigger-controller:
+k8s-trigger-controller only support for deployment rollout. It does not support daemonsets and statefulsets rollout.
+
+#### Reloader:
+Reloader supports deployment rollout as well as daemonsets and statefulsets rollout.
+
+### Hashing usage
+
+#### k8s-trigger-controller:
+k8s-trigger-controller stores the hash value in an annotation `trigger.k8s.io/[secret|configMap]-NAME-last-hash`
+
+#### Reloader:
+Reloader stores the hash value in an environment variable `STAKATER_NAME_[SECRET|CONFIGMAP]`

docs/Verify-Reloader-Working.md

@@ -0,0 +1,51 @@
+# Verify Reloader's Working
+
+Reloader's working can be verified by two ways.
+
+## Verify from logs
+
+Check the logs of reloader and verify that you can see logs looks like below, if you are able to find these logs then it means reloader is working.
+
+```text
+Changes Detected in test-object of type 'SECRET' in namespace: test-reloader
+
+Updated test-resource of type Deployment in namespace: test-reloader
+```
+
+Below are the details that explain these logs:
+
+### test-object
+
+`test-object` is the name of a `secret` or a `deployment` in which change has been detected.
+
+### SECRET
+
+`SECRET` is the type of `test-object`. It can either be `SECRET` or `CONFIGMAP`
+
+### test-reloader
+
+`test-reloader` is the name of namespace in which reloader has detected the change.
+
+### test-resource
+
+`test-resource` is the name of resource which is going to be updated
+
+### Deployment
+
+`Deployment` is the type of `test-resource`. It can either be a `Deployment`, `Daemonset` or `Statefulset`
+
+## Verify by checking the age of Pod
+
+A pod's age can tell whether reloader is working correctly or not. If you know that a change in a `secret` or `configmap` has occurred, then check the relevant Pod's age immediately. It should be newly created few moments ago.
+
+### Verify from kubernetes Dashboard
+
+`kubernetes dashboard` can be used to verify the working of Reloader. After a change in `secret` or `configmap`, check the relevant Pod's age from dashboard. It should be newly created few moments ago.
+
+### Verify from command line
+
+After a change in `secret` or `configmap`. Run the below mentioned command and verify that the pod is newly created.
+
+```bash
+kubectl get pods <pod name> -n <namespace name>
+```

docs/features.md

@@ -0,0 +1,7 @@
+# Features
+
+These are the key features of Reloader:
+
+1. Restart pod in a depoloyment on change in linked/related configmap's or secret's
+2. Restart pod in a daemonset on change in linked/related configmap's or secret's
+3. Restart pod in a statefulset on change in linked/related configmap's or secret's

internal/pkg/constants/constants.go

@@ -2,9 +2,9 @@ package constants
 
 const (
 	// ConfigmapEnvVarPostfix is a postfix for configmap envVar
-	ConfigmapEnvVarPostfix = "_CONFIGMAP"
+	ConfigmapEnvVarPostfix = "CONFIGMAP"
 	// SecretEnvVarPostfix is a postfix for secret envVar
-	SecretEnvVarPostfix = "_SECRET"
+	SecretEnvVarPostfix = "SECRET"
 	// EnvVarPrefix is a Prefix for environment variable
 	EnvVarPrefix = "STAKATER_"
 )

internal/pkg/controller/controller_test.go

@@ -15,7 +15,7 @@ import (
 
 var (
 	client              = testutil.GetClient()
-	namespace           = "test-reloader"
+	namespace           = "test-reloader-" + testutil.RandSeq(5)
 	configmapNamePrefix = "testconfigmap-reloader"
 	secretNamePrefix    = "testsecret-reloader"
 	data                = "dGVzdFNlY3JldEVuY29kaW5nRm9yUmVsb2FkZXI="
@@ -25,7 +25,6 @@ var (
 
 func TestMain(m *testing.M) {
 
-	logrus.Infof("Creating namespace %s", namespace)
 	testutil.CreateNamespace(namespace, client)
 
 	logrus.Infof("Creating controller")
@@ -45,7 +44,6 @@ func TestMain(m *testing.M) {
 	logrus.Infof("Running Testcases")
 	retCode := m.Run()
 
-	logrus.Infof("Deleting namespace %q.\n", namespace)
 	testutil.DeleteNamespace(namespace, client)
 
 	os.Exit(retCode)
@@ -268,7 +266,6 @@ func TestControllerUpdatingSecretShouldCreateEnvInDeployment(t *testing.T) {
 	if !updated {
 		t.Errorf("Deployment was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting Deployment
 	err = testutil.DeleteDeployment(client, namespace, secretName)
@@ -330,7 +327,6 @@ func TestControllerUpdatingSecretShouldUpdateEnvInDeployment(t *testing.T) {
 	if !updated {
 		t.Errorf("Deployment was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting Deployment
 	err = testutil.DeleteDeployment(client, namespace, secretName)
@@ -385,7 +381,6 @@ func TestControllerUpdatingSecretLabelsShouldNotCreateorUpdateEnvInDeployment(t
 	if updated {
 		t.Errorf("Deployment should not be updated by changing label in secret")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting Deployment
 	err = testutil.DeleteDeployment(client, namespace, secretName)
@@ -559,7 +554,6 @@ func TestControllerUpdatingSecretShouldCreateEnvInDaemonSet(t *testing.T) {
 	if !updated {
 		t.Errorf("DaemonSet was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting DaemonSet
 	err = testutil.DeleteDaemonSet(client, namespace, secretName)
@@ -622,7 +616,6 @@ func TestControllerUpdatingSecretShouldUpdateEnvInDaemonSet(t *testing.T) {
 	if !updated {
 		t.Errorf("DaemonSet was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting DaemonSet
 	err = testutil.DeleteDaemonSet(client, namespace, secretName)
@@ -677,7 +670,6 @@ func TestControllerUpdatingSecretLabelsShouldNotCreateorUpdateEnvInDaemonSet(t *
 	if updated {
 		t.Errorf("DaemonSet should not be updated by changing label in secret")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting DaemonSet
 	err = testutil.DeleteDaemonSet(client, namespace, secretName)
@@ -851,7 +843,6 @@ func TestControllerUpdatingSecretShouldCreateEnvInStatefulSet(t *testing.T) {
 	if !updated {
 		t.Errorf("StatefulSet was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting StatefulSet
 	err = testutil.DeleteStatefulSet(client, namespace, secretName)
@@ -913,7 +904,6 @@ func TestControllerUpdatingSecretShouldUpdateEnvInStatefulSet(t *testing.T) {
 	if !updated {
 		t.Errorf("StatefulSet was not updated")
 	}
-	//time.Sleep(5 * time.Second)
 
 	// Deleting StatefulSet
 	err = testutil.DeleteStatefulSet(client, namespace, secretName)

internal/pkg/handler/create.go

@@ -2,7 +2,6 @@ package handler
 
 import (
 	"github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
 )
 
 // ResourceCreatedHandler contains new objects
@@ -13,17 +12,7 @@ type ResourceCreatedHandler struct {
 // Handle processes the newly created resource
 func (r ResourceCreatedHandler) Handle() error {
 	if r.Resource == nil {
-		logrus.Errorf("Error in Handler")
-	} else {
-		logrus.Infof("Detected changes in object %s", r.Resource)
-		// process resource based on its type
-		if _, ok := r.Resource.(*v1.ConfigMap); ok {
-			logrus.Infof("A 'configmap' has been 'Added' but no implementation found to take action")
-		} else if _, ok := r.Resource.(*v1.Secret); ok {
-			logrus.Infof("A 'secret' has been 'Added' but no implementation found to take action")
-		} else {
-			logrus.Warnf("Invalid resource: Resource should be 'Secret' or 'Configmap' but found, %v", r.Resource)
-		}
+		logrus.Errorf("Resource creation handler received nil resource")
 	}
 	return nil
 }

internal/pkg/handler/update.go

@@ -23,47 +23,44 @@ type ResourceUpdatedHandler struct {
 // Handle processes the updated resource
 func (r ResourceUpdatedHandler) Handle() error {
 	if r.Resource == nil || r.OldResource == nil {
-		logrus.Errorf("Error in Handler")
+		logrus.Errorf("Resource update handler received nil resource")
 	} else {
-		logrus.Infof("Detected changes in object %s", r.Resource)
-		// process resource based on its type
-		rollingUpgrade(r, callbacks.RollingUpgradeFuncs{
-			ItemsFunc:      callbacks.GetDeploymentItems,
-			ContainersFunc: callbacks.GetDeploymentContainers,
-			UpdateFunc:     callbacks.UpdateDeployment,
-			ResourceType:   "Deployment",
-		})
-		rollingUpgrade(r, callbacks.RollingUpgradeFuncs{
-			ItemsFunc:      callbacks.GetDaemonSetItems,
-			ContainersFunc: callbacks.GetDaemonSetContainers,
-			UpdateFunc:     callbacks.UpdateDaemonSet,
-			ResourceType:   "DaemonSet",
-		})
-		rollingUpgrade(r, callbacks.RollingUpgradeFuncs{
-			ItemsFunc:      callbacks.GetStatefulSetItems,
-			ContainersFunc: callbacks.GetStatefulsetContainers,
-			UpdateFunc:     callbacks.UpdateStatefulset,
-			ResourceType:   "StatefulSet",
-		})
+		config, envVarPostfix, oldSHAData := getConfig(r)
+		if config.SHAValue != oldSHAData {
+			logrus.Infof("Changes detected in %s of type '%s' in namespace: %s", config.ResourceName, envVarPostfix, config.Namespace)
+			// process resource based on its type
+			rollingUpgrade(r, config, envVarPostfix, callbacks.RollingUpgradeFuncs{
+				ItemsFunc:      callbacks.GetDeploymentItems,
+				ContainersFunc: callbacks.GetDeploymentContainers,
+				UpdateFunc:     callbacks.UpdateDeployment,
+				ResourceType:   "Deployment",
+			})
+			rollingUpgrade(r, config, envVarPostfix, callbacks.RollingUpgradeFuncs{
+				ItemsFunc:      callbacks.GetDaemonSetItems,
+				ContainersFunc: callbacks.GetDaemonSetContainers,
+				UpdateFunc:     callbacks.UpdateDaemonSet,
+				ResourceType:   "DaemonSet",
+			})
+			rollingUpgrade(r, config, envVarPostfix, callbacks.RollingUpgradeFuncs{
+				ItemsFunc:      callbacks.GetStatefulSetItems,
+				ContainersFunc: callbacks.GetStatefulsetContainers,
+				UpdateFunc:     callbacks.UpdateStatefulset,
+				ResourceType:   "StatefulSet",
+			})
+		}
 	}
 	return nil
 }
 
-func rollingUpgrade(r ResourceUpdatedHandler, upgradeFuncs callbacks.RollingUpgradeFuncs) {
+func rollingUpgrade(r ResourceUpdatedHandler, config util.Config, envarPostfix string, upgradeFuncs callbacks.RollingUpgradeFuncs) {
 	client, err := kube.GetClient()
 	if err != nil {
 		logrus.Fatalf("Unable to create Kubernetes client error = %v", err)
 	}
 
-	config, envVarPostfix, oldSHAData := getConfig(r)
-
-	if config.SHAValue != oldSHAData {
-		err = PerformRollingUpgrade(client, config, envVarPostfix, upgradeFuncs)
-		if err != nil {
-			logrus.Fatalf("Rolling upgrade failed with error = %v", err)
-		}
-	} else {
-		logrus.Infof("Rolling upgrade will not happend because no actual change in data has been detected")
+	err = PerformRollingUpgrade(client, config, envarPostfix, upgradeFuncs)
+	if err != nil {
+		logrus.Errorf("Rolling upgrade for %s failed with error = %v", config.ResourceName, err)
 	}
 }
 
@@ -71,12 +68,10 @@ func getConfig(r ResourceUpdatedHandler) (util.Config, string, string) {
 	var oldSHAData, envVarPostfix string
 	var config util.Config
 	if _, ok := r.Resource.(*v1.ConfigMap); ok {
-		logrus.Infof("Performing 'Updated' action for resource of type 'configmap'")
 		oldSHAData = getSHAfromConfigmap(r.OldResource.(*v1.ConfigMap).Data)
 		config = getConfigmapConfig(r)
 		envVarPostfix = constants.ConfigmapEnvVarPostfix
 	} else if _, ok := r.Resource.(*v1.Secret); ok {
-		logrus.Infof("Performing 'Updated' action for resource of type 'secret'")
 		oldSHAData = getSHAfromSecret(r.OldResource.(*v1.Secret).Data)
 		config = getSecretConfig(r)
 		envVarPostfix = constants.SecretEnvVarPostfix
@@ -112,6 +107,7 @@ func PerformRollingUpgrade(client kubernetes.Interface, config util.Config, enva
 	var err error
 	for _, i := range items {
 		containers := upgradeFuncs.ContainersFunc(i)
+		resourceName := util.ToObjectMeta(i).Name
 		// find correct annotation and update the resource
 		annotationValue := util.ToObjectMeta(i).Annotations[config.Annotation]
 		if annotationValue != "" {
@@ -120,13 +116,13 @@ func PerformRollingUpgrade(client kubernetes.Interface, config util.Config, enva
 				if value == config.ResourceName {
 					updated := updateContainers(containers, value, config.SHAValue, envarPostfix)
 					if !updated {
-						logrus.Warnf("Rolling upgrade did not happen")
+						logrus.Warnf("Rolling upgrade failed because no container found to add environment variable in %s of type %s in namespace: %s", resourceName, upgradeFuncs.ResourceType, config.Namespace)
 					} else {
 						err = upgradeFuncs.UpdateFunc(client, config.Namespace, i)
 						if err != nil {
-							logrus.Errorf("Update %s failed %v", upgradeFuncs.ResourceType, err)
+							logrus.Errorf("Update for %s of type %s in namespace %s failed with error %v", resourceName, upgradeFuncs.ResourceType, config.Namespace, err)
 						} else {
-							logrus.Infof("Updated %s of type %s", config.ResourceName, upgradeFuncs.ResourceType)
+							logrus.Infof("Updated %s of type %s in namespace: %s ", resourceName, upgradeFuncs.ResourceType, config.Namespace)
 						}
 						break
 					}
@@ -139,8 +135,7 @@ func PerformRollingUpgrade(client kubernetes.Interface, config util.Config, enva
 
 func updateContainers(containers []v1.Container, annotationValue string, shaData string, envarPostfix string) bool {
 	updated := false
-	envar := constants.EnvVarPrefix + util.ConvertToEnvVarName(annotationValue) + envarPostfix
-	logrus.Infof("Generated environment variable: %s", envar)
+	envar := constants.EnvVarPrefix + util.ConvertToEnvVarName(annotationValue)+ "_" + envarPostfix
 	for i := range containers {
 		envs := containers[i].Env
 
@@ -155,7 +150,6 @@ func updateContainers(containers []v1.Container, annotationValue string, shaData
 			}
 			containers[i].Env = append(containers[i].Env, e)
 			updated = true
-			logrus.Infof("%s environment variable does not exist, creating a new envVar", envar)
 		}
 	}
 	return updated
@@ -164,9 +158,7 @@ func updateContainers(containers []v1.Container, annotationValue string, shaData
 func updateEnvVar(envs []v1.EnvVar, envar string, shaData string) bool {
 	for j := range envs {
 		if envs[j].Name == envar {
-			logrus.Infof("%s environment variable found", envar)
 			if envs[j].Value != shaData {
-				logrus.Infof("Updating %s", envar)
 				envs[j].Value = shaData
 				return true
 			}

internal/pkg/handler/update_test.go

@@ -15,14 +15,14 @@ import (
 
 var (
 	client        = testclient.NewSimpleClientset()
-	namespace     = "test-handler"
+	namespace     = "test-handler-" + testutil.RandSeq(5)
 	configmapName = "testconfigmap-handler-" + testutil.RandSeq(5)
 	secretName    = "testsecret-handler-" + testutil.RandSeq(5)
 )
 
 func TestMain(m *testing.M) {
 
-	logrus.Infof("Creating namespace %s", namespace)
+	// Creating namespace
 	testutil.CreateNamespace(namespace, client)
 
 	logrus.Infof("Setting up the test resources")

internal/pkg/testutil/kube.go

@@ -236,7 +236,6 @@ func GetResourceSHA(containers []v1.Container, envar string) string {
 //ConvertResourceToSHA generates SHA from secret or configmap data
 func ConvertResourceToSHA(resourceType string, namespace string, resourceName string, data string) string {
 	values := []string{}
-	logrus.Infof("Generating SHA for secret data")
 	if resourceType == SecretResourceType {
 		secret := GetSecret(namespace, resourceName, data)
 		for k, v := range secret.Data {
@@ -391,7 +390,7 @@ func VerifyResourceUpdate(client kubernetes.Interface, config util.Config, envVa
 				}
 			}
 			if matches {
-				envName := constants.EnvVarPrefix + util.ConvertToEnvVarName(annotationValue) + envVarPostfix
+				envName := constants.EnvVarPrefix + util.ConvertToEnvVarName(annotationValue) + "_" + envVarPostfix
 				updated := GetResourceSHA(containers, envName)
 
 				if updated == config.SHAValue {