From 7a185bc5baa0109ba49244b6f5a4ac6e9a22fe58 Mon Sep 17 00:00:00 2001 From: tom1299 Date: Tue, 20 May 2025 07:02:35 +0200 Subject: [PATCH] Improve resource / namespace selector documentation and logging --- README.md | 2 +- deployments/kubernetes/chart/reloader/README.md | 2 +- deployments/kubernetes/chart/reloader/values.yaml | 4 ++-- internal/pkg/cmd/reloader.go | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 84def7598..bd516b01c 100644 --- a/README.md +++ b/README.md @@ -294,7 +294,7 @@ Reloader supports multiple strategies for triggering rolling updates when a watc |------|-------------| | `--resources-to-ignore=configmaps` | Ignore ConfigMaps (only one type can be ignored at a time) | | `--resources-to-ignore=secrets` | Ignore Secrets (cannot combine with configMaps) | -| `--resource-label-selector=key=value` | Only watch ConfigMaps/Secrets with matching labels | +| `--resource-label-selector=key=value` | Only watch ConfigMaps/Secrets whose labels match this selector | > **⚠️ Note:** > Only **one** resource type can be ignored at a time. diff --git a/deployments/kubernetes/chart/reloader/README.md b/deployments/kubernetes/chart/reloader/README.md index d85e27013..ccec3f704 100644 --- a/deployments/kubernetes/chart/reloader/README.md +++ b/deployments/kubernetes/chart/reloader/README.md @@ -53,7 +53,7 @@ helm uninstall {{RELEASE_NAME}} -n {{NAMESPACE}} | `reloader.reloadStrategy` | Strategy to trigger resource restart, set to either `default`, `env-vars` or `annotations` | enumeration | `default` | | `reloader.ignoreNamespaces` | List of comma separated namespaces to ignore, if multiple are provided, they are combined with the AND operator | string | `""` | | `reloader.namespaceSelector` | List of comma separated k8s label selectors for namespaces selection. See [LIST and WATCH filtering](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#list-and-watch-filtering) for more details on label-selector | string | `""` | -| `reloader.resourceLabelSelector` | List of comma separated label selectors, if multiple are provided they are combined with the AND operator | string | `""` | +| `reloader.resourceLabelSelector` | Only watch ConfigMaps/Secrets whose labels match this selector | string | `""` | | `reloader.logFormat` | Set type of log format. Value could be either `json` or `""` | string | `""` | | `reloader.watchGlobally` | Allow Reloader to watch in all namespaces (`true`) or just in a single namespace (`false`) | boolean | `true` | | `reloader.enableHA` | Enable leadership election allowing you to run multiple replicas | boolean | `false` | diff --git a/deployments/kubernetes/chart/reloader/values.yaml b/deployments/kubernetes/chart/reloader/values.yaml index 67db45733..66a57c7bc 100644 --- a/deployments/kubernetes/chart/reloader/values.yaml +++ b/deployments/kubernetes/chart/reloader/values.yaml @@ -34,8 +34,8 @@ reloader: syncAfterRestart: false reloadStrategy: default # Set to default, env-vars or annotations ignoreNamespaces: "" # Comma separated list of namespaces to ignore - namespaceSelector: "" # Comma separated list of k8s label selectors for namespaces selection - resourceLabelSelector: "" # Comma separated list of k8s label selectors for configmap/secret selection + namespaceSelector: "" # Label selector for namespaces selection + resourceLabelSelector: "" # Label selector for configmap/secret selection logFormat: "" # json logLevel: info # Log level to use (trace, debug, info, warning, error, fatal and panic) watchGlobally: true diff --git a/internal/pkg/cmd/reloader.go b/internal/pkg/cmd/reloader.go index f0aac834b..b01034511 100644 --- a/internal/pkg/cmd/reloader.go +++ b/internal/pkg/cmd/reloader.go @@ -161,11 +161,11 @@ func startReloader(cmd *cobra.Command, args []string) { } if len(namespaceLabelSelector) > 0 { - logrus.Warnf("namespace-selector is set, will only detect changes in namespaces with these labels: %s.", namespaceLabelSelector) + logrus.Warnf("namespace-selector is set, will only detect changes in namespaces whose labels match this selector: %s.", namespaceLabelSelector) } if len(resourceLabelSelector) > 0 { - logrus.Warnf("resource-label-selector is set, will only detect changes on resources with these labels: %s.", resourceLabelSelector) + logrus.Warnf("resource-label-selector is set, will only detect changes on resources whose labels match this selector: %s.", resourceLabelSelector) } if options.WebhookUrl != "" {