Mark k8s-workload-registrar as deprecated (spiffe#3526)

Fixes: spiffe#3501 Signed-off-by: Andrew Harding <[email protected]>
stevend-uber · Oct 13, 2023 · 7df0e40 · 7df0e40
1 parent 3839d13
commit 7df0e40
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/support/k8s/k8s-workload-registrar/README.md b/support/k8s/k8s-workload-registrar/README.md
@@ -1,5 +1,7 @@
 # SPIRE Kubernetes Workload Registrar
 
+** The SPIRE Kubernetes Workload Registrar is deprecated and no longer maintained. Please migrate to the [SPIRE Controller Manager](https://github.com/spiffe/spire-controller-manager). **
+
 The SPIRE Kubernetes Workload Registrar implements a Kubernetes
 ValidatingAdmissionWebhook that facilitates automatic workload registration
 within Kubernetes.

diff --git a/support/k8s/k8s-workload-registrar/config_crd.go b/support/k8s/k8s-workload-registrar/config_crd.go
@@ -105,6 +105,8 @@ func (c *CRDMode) Run(ctx context.Context) error {
 	}
 	defer log.Close()
 
+	log.Warn("The k8s-workload-registrar is deprecated and no longer maintained. Please migrate to the SPIRE Controller Manager (https://github.com/spiffe/spire-controller-manager).")
+
 	// DEPRECATED: remove this check in 1.5.0 since all those who migrate through 1.4.0 will already have moved away
 	if c.LeaderElection && c.LeaderElectionResourceLock == configMapsResourceLock {
 		return errs.New(`the "configmaps" leader election resource lock type is no longer supported`)

diff --git a/support/k8s/k8s-workload-registrar/config_reconcile.go b/support/k8s/k8s-workload-registrar/config_reconcile.go
@@ -69,6 +69,8 @@ func (c *ReconcileMode) Run(ctx context.Context) error {
 	}))
 	setupLog := ctrl.Log.WithName("setup")
 
+	setupLog.Info("The k8s-workload-registrar is deprecated and no longer maintained. Please migrate to the SPIRE Controller Manager (https://github.com/spiffe/spire-controller-manager).")
+
 	// DEPRECATED: remove this check in 1.5.0 since all those who migrate through 1.4.0 will already have moved away
 	if c.LeaderElection && c.LeaderElectionResourceLock == configMapsResourceLock {
 		return errs.New(`the "configmaps" leader election resource lock type is no longer supported`)

diff --git a/support/k8s/k8s-workload-registrar/mode-crd/README.md b/support/k8s/k8s-workload-registrar/mode-crd/README.md
@@ -1,5 +1,7 @@
 # SPIRE Kubernetes Workload Registrar (CRD Mode)
 
+** The SPIRE Kubernetes Workload Registrar is deprecated and no longer maintained. Please migrate to the [SPIRE Controller Manager](https://github.com/spiffe/spire-controller-manager). **
+
 The CRD mode of the SPIRE Kubernetes Workload Registrar uses a Kubernetes Custom Resource Definition (CRD) to integrate SPIRE and Kubernetes.
 This enables auto and manual generation of SPIFFE IDs from with Kubernetes and the `kubectl` CLI.