Add ready condition (#1204)

benashz · web-flow · commit 08861e7ae296 · 2026-01-14T12:28:30.000-08:00
* Add Ready condition

* Clean up some docs
diff --git a/api/v1beta1/secrettransformation_types.go b/api/v1beta1/secrettransformation_types.go
@@ -22,6 +22,7 @@ type SecretTransformationStatus struct {
 
 // SecretTransformation is the Schema for the secrettransformations API
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type SecretTransformation struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/api/v1beta1/vaultauth_types.go b/api/v1beta1/vaultauth_types.go
@@ -447,6 +447,7 @@ type VaultAuthStatus struct {
 
 // VaultAuth is the Schema for the vaultauths API
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type VaultAuth struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/api/v1beta1/vaultconnection_types.go b/api/v1beta1/vaultconnection_types.go
@@ -41,6 +41,7 @@ type VaultConnectionStatus struct {
 
 // VaultConnection is the Schema for the vaultconnections API
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type VaultConnection struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/api/v1beta1/vaultdynamicsecret_types.go b/api/v1beta1/vaultdynamicsecret_types.go
@@ -135,6 +135,7 @@ type VaultStaticCredsMetaData struct {
 // VaultDynamicSecret is the Schema for the vaultdynamicsecrets API
 // +kubebuilder:printcolumn:name="Synced",type="string",JSONPath=`.status.conditions[?(@.type == "SecretSynced")].status`,description="secret sync status"
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type VaultDynamicSecret struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/api/v1beta1/vaultpkisecret_types.go b/api/v1beta1/vaultpkisecret_types.go
@@ -9,9 +9,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // VaultPKISecretSpec defines the desired state of VaultPKISecret
 type VaultPKISecretSpec struct {
 	// VaultAuthRef to the VaultAuth resource, can be prefixed with a namespace,
@@ -149,6 +146,7 @@ type VaultPKISecretStatus struct {
 // VaultPKISecret is the Schema for the vaultpkisecrets API
 // +kubebuilder:printcolumn:name="Synced",type="string",JSONPath=`.status.conditions[?(@.type == "SecretSynced")].status`,description="secret sync status"
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type VaultPKISecret struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/api/v1beta1/vaultstaticsecret_types.go b/api/v1beta1/vaultstaticsecret_types.go
@@ -7,9 +7,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // VaultStaticSecretSpec defines the desired state of VaultStaticSecret
 type VaultStaticSecretSpec struct {
 	// VaultAuthRef to the VaultAuth resource, can be prefixed with a namespace,
@@ -99,6 +96,7 @@ type VaultStaticSecretStatus struct {
 // VaultStaticSecret is the Schema for the vaultstaticsecrets API
 // +kubebuilder:printcolumn:name="Synced",type="string",JSONPath=`.status.conditions[?(@.type == "SecretSynced")].status`,description="secret sync status"
 // +kubebuilder:printcolumn:name="Healthy",type="string",JSONPath=`.status.conditions[?(@.type == "Healthy")].status`,description="health status"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.conditions[?(@.type == "Ready")].status`,description="resource ready"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp`,description="resource age"
 type VaultStaticSecret struct {
 	metav1.TypeMeta   `json:",inline"`
diff --git a/chart/crds/secrets.hashicorp.com_secrettransformations.yaml b/chart/crds/secrets.hashicorp.com_secrettransformations.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/chart/crds/secrets.hashicorp.com_vaultauths.yaml b/chart/crds/secrets.hashicorp.com_vaultauths.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/chart/crds/secrets.hashicorp.com_vaultconnections.yaml b/chart/crds/secrets.hashicorp.com_vaultconnections.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/chart/crds/secrets.hashicorp.com_vaultdynamicsecrets.yaml b/chart/crds/secrets.hashicorp.com_vaultdynamicsecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/chart/crds/secrets.hashicorp.com_vaultpkisecrets.yaml b/chart/crds/secrets.hashicorp.com_vaultpkisecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/chart/crds/secrets.hashicorp.com_vaultstaticsecrets.yaml b/chart/crds/secrets.hashicorp.com_vaultstaticsecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_secrettransformations.yaml b/config/crd/bases/secrets.hashicorp.com_secrettransformations.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_vaultauths.yaml b/config/crd/bases/secrets.hashicorp.com_vaultauths.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_vaultconnections.yaml b/config/crd/bases/secrets.hashicorp.com_vaultconnections.yaml
@@ -22,6 +22,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_vaultdynamicsecrets.yaml b/config/crd/bases/secrets.hashicorp.com_vaultdynamicsecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_vaultpkisecrets.yaml b/config/crd/bases/secrets.hashicorp.com_vaultpkisecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/config/crd/bases/secrets.hashicorp.com_vaultstaticsecrets.yaml b/config/crd/bases/secrets.hashicorp.com_vaultstaticsecrets.yaml
@@ -26,6 +26,10 @@ spec:
       jsonPath: .status.conditions[?(@.type == "Healthy")].status
       name: Healthy
       type: string
+    - description: resource ready
+      jsonPath: .status.conditions[?(@.type == "Ready")].status
+      name: Ready
+      type: string
     - description: resource age
       jsonPath: .metadata.creationTimestamp
       name: Age
diff --git a/consts/reasons.go b/consts/reasons.go
@@ -42,4 +42,5 @@ const (
 	ReasonEventWatcherStarted           = "EventWatcherStarted"
 	ReasonHealthy                       = "Healthy"
 	ReasonUnhealthy                     = "Unhealthy"
+	ReasonReady                         = "Ready"
 )
diff --git a/consts/types.go b/consts/types.go
@@ -9,4 +9,5 @@ var (
 	TypeSecretSynced       = "SecretSynced"
 	TypeLeaseRenewal       = "LeaseRenewal"
 	TypeHealthy            = "Healthy"
+	TypeReady              = "Ready"
 )
diff --git a/controllers/common.go b/controllers/common.go
@@ -365,3 +365,12 @@ func newHealthyCondition(o client.Object, healthy bool, objType string) metav1.C
 	}
 	return newConditionNow(o, consts.TypeHealthy, reason, conditionStatus, "%s%s", objType, reason)
 }
+
+func newReadyCondition(o client.Object, ready bool, objType string) metav1.Condition {
+	reason := consts.ReasonReady
+	conditionStatus := metav1.ConditionTrue
+	if !ready {
+		conditionStatus = metav1.ConditionFalse
+	}
+	return newConditionNow(o, consts.TypeReady, reason, conditionStatus, "%s%s", objType, reason)
+}
diff --git a/controllers/secrettransformation_controller.go b/controllers/secrettransformation_controller.go
@@ -82,7 +82,7 @@ func (r *SecretTransformationReconciler) updateStatus(ctx context.Context, o *se
 	logger := log.FromContext(ctx)
 	valid := ptr.Deref(o.Status.Valid, false)
 	metrics.SetResourceStatus("secrettransformation", o, valid)
-	o.Status.Conditions = updateConditions(o.Status.Conditions, newHealthyCondition(o, valid, "SecretsTransformation"))
+	o.Status.Conditions = updateConditions(o.Status.Conditions, newHealthyCondition(o, valid, "SecretsTransformation"), newReadyCondition(o, valid, "SecretsTransformation"))
 	if err := r.Status().Update(ctx, o); err != nil {
 		logger.Error(err, "Failed to update the resource's status")
 		return err
diff --git a/controllers/vaultauth_controller.go b/controllers/vaultauth_controller.go
@@ -210,7 +210,7 @@ func (r *VaultAuthReconciler) updateStatus(ctx context.Context, o *secretsv1beta
 	logger := log.FromContext(ctx)
 	valid := ptr.Deref(o.Status.Valid, false)
 	metrics.SetResourceStatus("vaultauth", o, valid)
-	o.Status.Conditions = updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, valid, "VaultAuth"))...)
+	o.Status.Conditions = updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, valid, "VaultAuth"), newReadyCondition(o, valid, "VaultAuth"))...)
 	if err := r.Status().Update(ctx, o); err != nil {
 		logger.Error(err, "Failed to update the resource's status")
 		return err
diff --git a/controllers/vaultconnection_controller.go b/controllers/vaultconnection_controller.go
@@ -175,7 +175,7 @@ func (r *VaultConnectionReconciler) updateStatus(ctx context.Context, o *secrets
 	logger := log.FromContext(ctx)
 	valid := ptr.Deref(o.Status.Valid, false)
 	metrics.SetResourceStatus("vaultconnection", o, valid)
-	o.Status.Conditions = updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, valid, "VaultConnection"))...)
+	o.Status.Conditions = updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, valid, "VaultConnection"), newReadyCondition(o, valid, "VaultConnection"))...)
 	if err := r.Status().Update(ctx, o); err != nil {
 		logger.Error(err, "Failed to update the resource's status")
 		return err
diff --git a/controllers/vaultdynamicsecret_controller.go b/controllers/vaultdynamicsecret_controller.go
@@ -659,7 +659,7 @@ func (r *VaultDynamicSecretReconciler) updateStatus(ctx context.Context, o *secr
 
 	o.Status.LastGeneration = o.GetGeneration()
 
-	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultDynamicSecret"))...)
+	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultDynamicSecret"), newReadyCondition(o, healthy, "VaultDynamicSecret"))...)
 	logger.V(consts.LogLevelDebug).Info("Updating status", "n", n, "o", o.Status.Conditions)
 	o.Status.Conditions = n
 	if err := r.Status().Update(ctx, o); err != nil {
diff --git a/controllers/vaultpkisecret_controller.go b/controllers/vaultpkisecret_controller.go
@@ -454,7 +454,7 @@ func (r *VaultPKISecretReconciler) recordEvent(o *secretsv1beta1.VaultPKISecret,
 func (r *VaultPKISecretReconciler) updateStatus(ctx context.Context, o *secretsv1beta1.VaultPKISecret, healthy bool, conditions ...metav1.Condition) error {
 	logger := log.FromContext(ctx).WithName("updateStatus")
 	logger.V(consts.LogLevelDebug).Info("Updating status")
-	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultPKISecret"))...)
+	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultPKISecret"), newReadyCondition(o, healthy, "VaultPKISecret"))...)
 	logger.V(consts.LogLevelDebug).Info("Updating status", "n", n, "o", o.Status.Conditions)
 	o.Status.Conditions = n
 
diff --git a/controllers/vaultstaticsecret_controller.go b/controllers/vaultstaticsecret_controller.go
@@ -309,7 +309,7 @@ func (r *VaultStaticSecretReconciler) updateStatus(ctx context.Context, o *secre
 	logger := log.FromContext(ctx).WithName("updateStatus")
 	logger.V(consts.LogLevelDebug).Info("Updating status")
 	o.Status.LastGeneration = o.GetGeneration()
-	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultStaticSecret"))...)
+	n := updateConditions(o.Status.Conditions, append(conditions, newHealthyCondition(o, healthy, "VaultStaticSecret"), newReadyCondition(o, healthy, "VaultStaticSecret"))...)
 	logger.V(consts.LogLevelDebug).Info("Updating status", "n", n, "o", o.Status.Conditions)
 	o.Status.Conditions = n
 
