From ae4fabc635e8213e0686f766f66cdd87d73dfbae Mon Sep 17 00:00:00 2001 From: faizanahmad055 Date: Mon, 9 Jul 2018 13:24:01 +0500 Subject: [PATCH] Remove duplicate readme --- README.1.md | 23 ----------------------- README.md | 24 +++++++++++++++++++++++- 2 files changed, 23 insertions(+), 24 deletions(-) delete mode 100644 README.1.md diff --git a/README.1.md b/README.1.md deleted file mode 100644 index 53146836..00000000 --- a/README.1.md +++ /dev/null @@ -1,23 +0,0 @@ -# configmapcontroller - -This controller watches for changes to `ConfigMap` and `Secret` objects and performs rolling upgrades on their associated deployments, deamonsets and statefulsets and updating dynamically. - -This is particularly useful if the `ConfigMap` is used to define environment variables - or your app cannot easily and reliably watch the `ConfigMap` and update itself on the fly. - -## How to use configmapcontroller - -For a `Deployment` called `foo` have a `ConfigMap` called `foo`. Then add this annotation to your `Deployment` - -```yaml -metadata: - annotations: - configmap.fabric8.io/update-on-change: "foo" -``` - -Then, providing `configmapcontroller` is running, whenever you edit the `ConfigMap` called `foo` the configmapcontroller will update the `Deployment` by adding the environment variable: - -``` -FABRICB_FOO_REVISION=${configMapRevision} -``` - -This then triggers a rolling upgrade of your deployment's pods to use the new configuration. diff --git a/README.md b/README.md index ba495473..fcddf26a 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# Reloader \ No newline at end of file +# Reloader + +This controller watches for changes to `ConfigMap` and `Secret` objects and performs rolling upgrades on their associated deployments, deamonsets and statefulsets and updating dynamically. + +This is particularly useful if the `ConfigMap` is used to define environment variables - or your app cannot easily and reliably watch the `ConfigMap` and update itself on the fly. + +## How to use Reloader + +For a `Deployment` called `foo` have a `ConfigMap` called `foo`. Then add this annotation to your `Deployment` + +```yaml +metadata: + annotations: + configmap.fabric8.io/update-on-change: "foo" +``` + +Then, providing `Reloader` is running, whenever you edit the `ConfigMap` called `foo` the Reloader will update the `Deployment` by adding the environment variable: + +``` +FABRICB_FOO_REVISION=${configMapRevision} +``` + +This then triggers a rolling upgrade of your deployment's pods to use the new configuration.