diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml index 2732f0f7..5e9265c1 100644 --- a/.github/workflows/pull_request.yaml +++ b/.github/workflows/pull_request.yaml @@ -14,7 +14,7 @@ env: jobs: qa: - uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.62 + uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.64 with: MD_CONFIG: .github/md_config.json DOC_SRC: README.md docs diff --git a/.gitignore b/.gitignore index 396f6030..91af8d8e 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,5 @@ vendor dist Reloader !**/chart/reloader -*.tgz \ No newline at end of file +*.tgz +styles/ diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index a47a9fc2..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "vocabulary"] - path = vocabulary - url = git@github.com:stakater/vocabulary.git diff --git a/.vale.ini b/.vale.ini index 56d1b754..a024581a 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,7 +1,8 @@ -StylesPath = "vocabulary/styles" +StylesPath = styles MinAlertLevel = warning -Vocab = "Stakater" +Packages = https://github.com/stakater/vale-package/releases/download/v0.0.6/Stakater.zip +Vocab = Stakater # Only check MarkDown files [*.md] diff --git a/README.md b/README.md index 222fc23f..2e988c58 100644 --- a/README.md +++ b/README.md @@ -308,9 +308,9 @@ Reloader can be configured to only watch configmaps/secrets labeled with one or **Note:** Both `namespaceSelector` & `resourceLabelSelector` can be used together. If they are then both conditions must be met for the configmap or secret to be eligible to trigger reload events. (e.g. If a configMap matches `resourceLabelSelector` but `namespaceSelector` does not match the namespace the configmap is in, it will be ignored). -You can also set the log format of Reloader to json by setting `logFormat` to `json` in values.yaml and apply the chart. +You can also set the log format of Reloader to JSON by setting `logFormat` to `json` in `values.yaml` and apply the chart. -You can enable to scrape Reloader's Prometheus metrics by setting `serviceMonitor.enabled` or `podMonitor.enabled` to `true` in values.yaml file. Service monitor will be removed in future releases of Reloader in favour of Pod monitor. +You can enable to scrape Reloader's Prometheus metrics by setting `serviceMonitor.enabled` or `podMonitor.enabled` to `true` in `values.yaml` file. Service monitor will be removed in future releases of Reloader in favour of Pod monitor. **Note:** Reloading of OpenShift (DeploymentConfig) and/or Argo `Rollouts` has to be enabled explicitly because it might not be always possible to use it on a cluster with restricted permissions. This can be done by changing the following parameters: @@ -321,7 +321,7 @@ You can enable to scrape Reloader's Prometheus metrics by setting `serviceMonito | reloadOnCreate | Enable reload on create events. Valid value are either `true` or `false` | boolean | | syncAfterRestart | Enable sync after Reloader restarts for **Add** events, works only when reloadOnCreate is `true`. Valid value are either `true` or `false` | boolean | -**isOpenShift** Recent versions of OpenShift (tested on 4.13.3) require the specified user to be in an uid range which is dynamically assigned by the namespace. The solution is to unset the runAsUser variable via ``deployment.securityContext.runAsUser=null`` and let OpenShift assign it at install. +**isOpenShift** Recent versions of OpenShift (tested on 4.13.3) require the specified user to be in an `uid` range which is dynamically assigned by the namespace. The solution is to unset the runAsUser variable via ``deployment.securityContext.runAsUser=null`` and let OpenShift assign it at install. **ReloadOnCreate** reloadOnCreate controls how Reloader handles secrets being added to the cache for the first time. If reloadOnCreate is set to true: diff --git a/docs/Alerting.md b/docs/Alerting.md index b4a6b1a0..6b493f97 100644 --- a/docs/Alerting.md +++ b/docs/Alerting.md @@ -4,7 +4,7 @@ Reloader can alert when it triggers a rolling upgrade on Deployments or Stateful ## Enabling the feature -In-order to enable this feature, you need to update the `reloader.env.secret` section of values.yaml providing the information needed for alert. +In-order to enable this feature, you need to update the `reloader.env.secret` section of `values.yaml` providing the information needed for alert: ```yaml ALERT_ON_RELOAD: [ true/false ] Default: false diff --git a/renovate.json b/renovate.json index 39a2b6e9..39e38959 100644 --- a/renovate.json +++ b/renovate.json @@ -1,6 +1,21 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": [ - "config:base" + "config:recommended" + ], + "labels": [ + "dependencies" + ], + "customManagers": [ + { + "customType": "regex", + "fileMatch": [ + ".vale.ini" + ], + "matchStrings": [ + "https:\/\/github\\.com\/(?.*)\/releases\/download\/(?.*)\/.*\\.zip" + ], + "datasourceTemplate": "github-releases" + } ] } diff --git a/vocabulary b/vocabulary deleted file mode 160000 index 899bf2db..00000000 --- a/vocabulary +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 899bf2db35556f2e1abf5452081b7c3ad8f1765a