diff --git a/.vale.ini b/.vale.ini index 3a737bb..24bb702 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,7 +1,7 @@ StylesPath = styles MinAlertLevel = warning -Packages = https://github.com/stakater/vale-package/releases/download/v0.0.47/Stakater.zip +Packages = https://github.com/stakater/vale-package/releases/download/v0.0.52/Stakater.zip Vocab = Stakater # Only check MarkDown files diff --git a/docs/How-it-works.md b/docs/How-it-works.md index 5f9f8a2..a93c9fb 100644 --- a/docs/How-it-works.md +++ b/docs/How-it-works.md @@ -54,7 +54,7 @@ When Reloader detects changes in configmap. It gets two objects of configmap. Fi 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 +### Environment Variable for Configmap If configmap name is foo then diff --git a/docs/Reloader-vs-ConfigmapController.md b/docs/Reloader-vs-ConfigmapController.md index 872040e..810e611 100644 --- a/docs/Reloader-vs-ConfigmapController.md +++ b/docs/Reloader-vs-ConfigmapController.md @@ -1,7 +1,6 @@ - # 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. | Reloader | Configmap | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/Reloader-with-Sealed-Secrets.md b/docs/Reloader-with-Sealed-Secrets.md index 363bc5b..4df328d 100644 --- a/docs/Reloader-with-Sealed-Secrets.md +++ b/docs/Reloader-with-Sealed-Secrets.md @@ -3,12 +3,12 @@ Below are the steps to use Reloader with Sealed Secrets: 1. Download and install the kubeseal client from [here](https://github.com/bitnami-labs/sealed-secrets) -1. Install the controller for sealed secrets +1. Install the controller for Sealed Secrets 1. Fetch the encryption certificate 1. Encrypt the secret 1. Apply the secret -1. Install the tool which uses that sealed secret +1. Install the tool which uses that Sealed Secret 1. Install Reloader 1. Once everything is setup, update the original secret at client and encrypt it with kubeseal to see Reloader working -1. Apply the updated sealed secret +1. Apply the updated Sealed Secret 1. Reloader will restart the pod to use that updated secret