|
1 | | -# vp-template |
| 1 | +# vp-stakater-reloader |
2 | 2 |
|
3 | | - |
| 3 | +  |
4 | 4 |
|
5 | | -A Helm chart to serve as the Validated Patterns Template |
| 5 | +Wrapper Helm chart for Stakater Reloader with defaults for cluster-wide OpenShift, ConfigMap/Secret watching, and Secrets Store CSI integration. |
6 | 6 |
|
7 | | -This chart is used to serve as the template for Validated Patterns Charts |
| 7 | +## Prerequisites |
8 | 8 |
|
9 | | -## Notable changes |
| 9 | +- Helm 3 or later |
| 10 | +- OpenShift (or Kubernetes) cluster |
| 11 | +- Optional: [Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/) and its CRDs if you rely on CSI-backed secret rotation (Reloader watches those APIs when `reloader.reloader.enableCSIIntegration` is true) |
10 | 12 |
|
11 | | ---- |
| 13 | +## Install |
12 | 14 |
|
| 15 | +Add this chart (or your chart repo) and install into a dedicated namespace, for example `reloader`: |
| 16 | + |
| 17 | +```bash |
| 18 | +helm install reloader /path/to/vp-stakater-reloader-chart \ |
| 19 | + --namespace reloader \ |
| 20 | + --create-namespace |
| 21 | +``` |
| 22 | + |
| 23 | +### OpenShift UID / SCC (recommended) |
| 24 | + |
| 25 | +Upstream Reloader defaults `runAsUser: 65534`. On OpenShift 4.13+, Stakater recommends letting the namespace SCC assign the UID. Helm value merging keeps that default unless you clear the key explicitly: |
| 26 | + |
| 27 | +```bash |
| 28 | +helm install reloader /path/to/vp-stakater-reloader-chart \ |
| 29 | + --namespace reloader \ |
| 30 | + --create-namespace \ |
| 31 | + --set reloader.reloader.deployment.securityContext.runAsUser=null |
| 32 | +``` |
| 33 | + |
| 34 | +### Maximum automation (`autoReloadAll`) |
| 35 | + |
| 36 | +This chart sets `reloader.reloader.autoReloadAll` to `false` so workloads opt in via Reloader annotations. To reload on ConfigMap/Secret changes by default (opt out with `reloader.stakater.com/auto: "false"` on a workload), set: |
| 37 | + |
| 38 | +```bash |
| 39 | +--set reloader.reloader.autoReloadAll=true |
| 40 | +``` |
| 41 | + |
| 42 | +## Upstream documentation |
| 43 | + |
| 44 | +- [Reloader OSS documentation](https://docs.stakater.com/reloader/) |
| 45 | +- [Annotations reference](https://docs.stakater.com/reloader/1.4/reference/annotations.html) |
| 46 | + |
| 47 | +## Maintainer tasks |
| 48 | + |
| 49 | +Refresh the vendored subchart after editing `Chart.yaml` dependencies: |
| 50 | + |
| 51 | +```bash |
| 52 | +make helm-deps |
| 53 | +``` |
| 54 | + |
| 55 | +**Homepage:** <https://github.com/stakater/Reloader> |
| 56 | + |
| 57 | +## Maintainers |
| 58 | + |
| 59 | +| Name | Email | Url | |
| 60 | +| ---- | ------ | --- | |
| 61 | +| Validated Patterns | | | |
| 62 | + |
| 63 | +## Source Code |
| 64 | + |
| 65 | +* <https://github.com/stakater/Reloader> |
| 66 | + |
| 67 | +## Requirements |
| 68 | + |
| 69 | +| Repository | Name | Version | |
| 70 | +|------------|------|---------| |
| 71 | +| https://stakater.github.io/stakater-charts | reloader | 2.2.11 | |
| 72 | + |
| 73 | +## Values |
| 74 | + |
| 75 | +| Key | Type | Default | Description | |
| 76 | +|-----|------|---------|-------------| |
| 77 | +| reloader.reloader.autoReloadAll | bool | `false` | Reload on ConfigMap or Secret changes by default; opt out per workload via Reloader annotations | |
| 78 | +| reloader.reloader.deployment.replicas | int | `2` | Number of controller replicas (requires enableHA when greater than 1) | |
| 79 | +| reloader.reloader.deployment.securityContext.runAsNonRoot | bool | `true` | Run as non-root | |
| 80 | +| reloader.reloader.deployment.securityContext.seccompProfile.type | string | `"RuntimeDefault"` | Seccomp profile for the pod | |
| 81 | +| reloader.reloader.enableCSIIntegration | bool | `true` | Watch Secrets Store CSI SecretProviderClass and SecretProviderClassPodStatus resources | |
| 82 | +| reloader.reloader.enableHA | bool | `true` | Enable leader election for multiple replicas | |
| 83 | +| reloader.reloader.ignoreConfigMaps | bool | `false` | Ignore ConfigMaps when true (cannot be true together with ignoreSecrets) | |
| 84 | +| reloader.reloader.ignoreCronJobs | bool | `false` | Exclude CronJobs from reload monitoring | |
| 85 | +| reloader.reloader.ignoreJobs | bool | `false` | Exclude Jobs from reload monitoring | |
| 86 | +| reloader.reloader.ignoreSecrets | bool | `false` | Ignore Secrets when true (cannot be true together with ignoreConfigMaps) | |
| 87 | +| reloader.reloader.isOpenshift | bool | `true` | Enable OpenShift DeploymentConfig RBAC when the API exists | |
| 88 | +| reloader.reloader.reloadOnCreate | bool | `true` | Trigger rollouts when new ConfigMaps or Secrets appear | |
| 89 | +| reloader.reloader.syncAfterRestart | bool | `true` | With HA, reconcile after leader restart (pairs with reloadOnCreate) | |
| 90 | +| reloader.reloader.watchGlobally | bool | `true` | Cluster-wide watch of all namespaces | |
| 91 | + |
| 92 | +---------------------------------------------- |
13 | 93 | Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) |
0 commit comments