Compare commits

..

10 Commits

Author SHA1 Message Date
stakater-user
ea62b0036c Bump Version to 0.0.14 2018-08-10 08:18:14 +00:00
Faizan Ahmad
decb9b06be Merge pull request #24 from stakater/fix-reloader-vs-configmapcontroller
fix Reloader vs ConfigmapController doc
2018-08-10 12:56:26 +05:00
faizanahmad055
94bd7bb694 Fix reloader vs configmapcontroller layout 2018-08-10 12:53:53 +05:00
stakater-user
67843f839a Bump Version to 0.0.13 2018-08-10 06:15:54 +00:00
Rasheed Amir
342395cd84 fix Reloader vs ConfigmapController doc
improve the doc quality
2018-08-10 08:05:12 +02:00
Rasheed Amir
695c5b05d2 create a feature docs for seo purposes (#22)
this doc will/might help users to find this git repo and use it
2018-08-10 07:53:38 +02:00
stakater-user
4d6da476ee Bump Version to 0.0.12 2018-08-10 00:34:51 +00:00
Ahmad Iqbal Ali
d5ea5d810d add docs link in README (#21) 2018-08-10 05:13:30 +05:00
stakater-user
0d10b35d3a Bump Version to 0.0.11 2018-08-03 21:38:04 +00:00
Rasheed Amir
807e0c0c1b cleanup the readme 2018-08-03 23:16:33 +02:00
9 changed files with 43 additions and 34 deletions

View File

@@ -1 +1 @@
0.0.10
0.0.14

View File

@@ -42,6 +42,8 @@ You can apply vanilla manifests by running the following command
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
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
@@ -54,13 +56,12 @@ helm repo update
helm install stakater/reloader
```
## Monitor All namespaces
By default Reloader gets deployed in `default` namespace and watches changes `secrets` and `configmaps` in all namespaces.
## 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

View File

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

View File

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

View File

@@ -7,8 +7,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader
@@ -29,7 +29,7 @@ spec:
spec:
containers:
- env:
image: "stakater/reloader:0.0.10"
image: "stakater/reloader:0.0.14"
imagePullPolicy: IfNotPresent
name: reloader
serviceAccountName: reloader

View File

@@ -7,8 +7,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader
@@ -20,8 +20,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader-role
@@ -57,8 +57,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader-role-binding

View File

@@ -7,8 +7,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader
@@ -29,7 +29,7 @@ spec:
spec:
containers:
- env:
image: "stakater/reloader:0.0.10"
image: "stakater/reloader:0.0.14"
imagePullPolicy: IfNotPresent
name: reloader
serviceAccountName: reloader
@@ -43,8 +43,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader
@@ -56,8 +56,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader-role
@@ -93,8 +93,8 @@ metadata:
app: reloader
group: com.stakater.platform
provider: stakater
version: 0.0.10
chart: "reloader-0.0.10"
version: 0.0.14
chart: "reloader-0.0.14"
release: "RELEASE-NAME"
heritage: "Tiller"
name: reloader-role-binding

View File

@@ -1,10 +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 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.
| Configmap | Reloader |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ConfigmapController can only watch changes in `configmaps`. It cannot detect changes in other resources like `secrets`. | Reloader on the other hand can watch and detect changes in both `secrets` and `configmaps`. |
| ConfigmapController can only perform rolling upgrades on `deployments`. It currently does not support rolling upgrades on `statefulsets` and `daemonsets` | Reloader on the other hand can perform rolling upgrades on `deployments` as well as on `statefulsets` and `daemonsets` |
| Currently there are no 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 if new changes break any older functionality or not. | 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 older functionality. |
| 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. | 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 also very less pron to collision. |
| 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. |

7
docs/features.md Normal file
View File

@@ -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