From 163aede486740beee9c6ad95f9e18e578b86ba5d Mon Sep 17 00:00:00 2001 From: Rasheed Amir Date: Fri, 10 Aug 2018 07:53:14 +0200 Subject: [PATCH] cleanup readme - add acknowledgements section - configmap or secret name doesn't need to be same as deployment name --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eb33960f..142135bc 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,30 @@ ## Problem -We would like to watch if some change happens in `ConfigMap` and `Secret` objects and then perform rolling 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 changes in `ConfigMap` and `Secret` and do rolling upgrades on Pods with their associated `Deployments`, `Deamonsets` and `Statefulsets`. -**NOTE:** This controller has been inspired from [configmapController](https://github.com/fabric8io/configmapcontroller) - ## How to use Reloader -For a `Deployment` called `foo` have a `ConfigMap` called `foo`. Then add this annotation to your `Deployment` +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` +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.reloader.stakater.com/reload: "foo-secret" ``` ## Deploying to Kubernetes @@ -106,3 +104,7 @@ or contact us in case of professional services and queries on