Add .status.phase to RootShards

embik · embik · commit 8857d1c89810 · 2025-01-09T15:59:59.000+01:00
On-behalf-of: SAP &lt;marvin.beckers@sap.com&gt;
Signed-off-by: Marvin Beckers &lt;marvin@kubermatic.com&gt;
diff --git a/api/v1alpha1/common.go b/api/v1alpha1/common.go
@@ -49,7 +49,7 @@ type ImageSpec struct {
 
 type RootShardConfig struct {
 	// Reference references a local RootShard object.
-	Reference *corev1.ObjectReference `json:"ref,omitempty"`
+	Reference *corev1.LocalObjectReference `json:"ref,omitempty"`
 }
 
 type EtcdConfig struct {
diff --git a/api/v1alpha1/rootshard_types.go b/api/v1alpha1/rootshard_types.go
@@ -84,12 +84,29 @@ type OIDCConfiguration struct {
 
 // RootShardStatus defines the observed state of RootShard
 type RootShardStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	Phase      RootShardPhase     `json:"phase,omitempty"`
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
 }
 
+type RootShardPhase string
+
+const (
+	RootShardPhaseProvisioning RootShardPhase = "Provisioning"
+	RootShardPhaseRunning      RootShardPhase = "Running"
+	RootShardPhaseDeleting     RootShardPhase = "Deleting"
+)
+
+type RootShardConditionType string
+
+const (
+	RootShardConditionTypeAvailable RootShardConditionType = "Available"
+)
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:JSONPath=".spec.external.hostname",name="Hostname",type="string"
+// +kubebuilder:printcolumn:JSONPath=".status.phase",name="Phase",type="string"
+// +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Age",type="date"
 
 // RootShard is the Schema for the kcpinstances API
 type RootShard struct {
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/operator.kcp.io_frontproxies.yaml b/config/crd/bases/operator.kcp.io_frontproxies.yaml
@@ -98,44 +98,15 @@ spec:
                   ref:
                     description: Reference references a local RootShard object.
                     properties:
-                      apiVersion:
-                        description: API version of the referent.
-                        type: string
-                      fieldPath:
-                        description: |-
-                          If referring to a piece of an object instead of an entire object, this string
-                          should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
-                          For example, if the object reference is to a container within a pod, this would take on a value like:
-                          "spec.containers{name}" (where "name" refers to the name of the container that triggered
-                          the event) or if no container name is specified "spec.containers[2]" (container with
-                          index 2 in this pod). This syntax is chosen only to have some well-defined way of
-                          referencing a part of an object.
-                        type: string
-                      kind:
-                        description: |-
-                          Kind of the referent.
-                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-                        type: string
                       name:
+                        default: ""
                         description: |-
                           Name of the referent.
+                          This field is effectively required, but due to backwards compatibility is
+                          allowed to be empty. Instances of this type with an empty value here are
+                          almost certainly wrong.
                           More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                         type: string
-                      namespace:
-                        description: |-
-                          Namespace of the referent.
-                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
-                        type: string
-                      resourceVersion:
-                        description: |-
-                          Specific resourceVersion to which this reference is made, if any.
-                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
-                        type: string
-                      uid:
-                        description: |-
-                          UID of the referent.
-                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
-                        type: string
                     type: object
                     x-kubernetes-map-type: atomic
                 type: object
diff --git a/config/crd/bases/operator.kcp.io_rootshards.yaml b/config/crd/bases/operator.kcp.io_rootshards.yaml
@@ -14,7 +14,17 @@ spec:
     singular: rootshard
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - jsonPath: .spec.external.hostname
+      name: Hostname
+      type: string
+    - jsonPath: .status.phase
+      name: Phase
+      type: string
+    - jsonPath: .metadata.creationTimestamp
+      name: Age
+      type: date
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: RootShard is the Schema for the kcpinstances API
@@ -188,6 +198,65 @@ spec:
             type: object
           status:
             description: RootShardStatus defines the observed state of RootShard
+            properties:
+              conditions:
+                items:
+                  description: Condition contains details for one aspect of the current
+                    state of this API Resource.
+                  properties:
+                    lastTransitionTime:
+                      description: |-
+                        lastTransitionTime is the last time the condition transitioned from one status to another.
+                        This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+                      format: date-time
+                      type: string
+                    message:
+                      description: |-
+                        message is a human readable message indicating details about the transition.
+                        This may be an empty string.
+                      maxLength: 32768
+                      type: string
+                    observedGeneration:
+                      description: |-
+                        observedGeneration represents the .metadata.generation that the condition was set based upon.
+                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                        with respect to the current state of the instance.
+                      format: int64
+                      minimum: 0
+                      type: integer
+                    reason:
+                      description: |-
+                        reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                        Producers of specific condition types may define expected values and meanings for this field,
+                        and whether the values are considered a guaranteed API.
+                        The value should be a CamelCase string.
+                        This field may not be empty.
+                      maxLength: 1024
+                      minLength: 1
+                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                      type: string
+                    status:
+                      description: status of the condition, one of True, False, Unknown.
+                      enum:
+                      - "True"
+                      - "False"
+                      - Unknown
+                      type: string
+                    type:
+                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                      maxLength: 316
+                      pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                      type: string
+                  required:
+                  - lastTransitionTime
+                  - message
+                  - reason
+                  - status
+                  - type
+                  type: object
+                type: array
+              phase:
+                type: string
             type: object
         type: object
     served: true
diff --git a/config/crd/bases/operator.kcp.io_shards.yaml b/config/crd/bases/operator.kcp.io_shards.yaml
@@ -120,44 +120,15 @@ spec:
                   ref:
                     description: Reference references a local RootShard object.
                     properties:
-                      apiVersion:
-                        description: API version of the referent.
-                        type: string
-                      fieldPath:
-                        description: |-
-                          If referring to a piece of an object instead of an entire object, this string
-                          should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
-                          For example, if the object reference is to a container within a pod, this would take on a value like:
-                          "spec.containers{name}" (where "name" refers to the name of the container that triggered
-                          the event) or if no container name is specified "spec.containers[2]" (container with
-                          index 2 in this pod). This syntax is chosen only to have some well-defined way of
-                          referencing a part of an object.
-                        type: string
-                      kind:
-                        description: |-
-                          Kind of the referent.
-                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-                        type: string
                       name:
+                        default: ""
                         description: |-
                           Name of the referent.
+                          This field is effectively required, but due to backwards compatibility is
+                          allowed to be empty. Instances of this type with an empty value here are
+                          almost certainly wrong.
                           More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                         type: string
-                      namespace:
-                        description: |-
-                          Namespace of the referent.
-                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
-                        type: string
-                      resourceVersion:
-                        description: |-
-                          Specific resourceVersion to which this reference is made, if any.
-                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
-                        type: string
-                      uid:
-                        description: |-
-                          UID of the referent.
-                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
-                        type: string
                     type: object
                     x-kubernetes-map-type: atomic
                 type: object
diff --git a/internal/controller/rootshard_controller.go b/internal/controller/rootshard_controller.go
@@ -22,7 +22,11 @@ import (
 
 	k8creconciling "k8c.io/reconciler/pkg/reconciling"
 
+	appsv1 "k8s.io/api/apps/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
@@ -65,6 +69,22 @@ func (r *RootShardReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		return ctrl.Result{}, fmt.Errorf("failed to find %s/%s: %w", req.Namespace, req.Name, err)
 	}
 
+	if rootShard.DeletionTimestamp != nil {
+		rootShard.Status.Phase = operatorkcpiov1alpha1.RootShardPhaseDeleting
+		if err := r.Client.Status().Update(ctx, &rootShard); err != nil {
+			return ctrl.Result{}, err
+		}
+	}
+
+	if rootShard.Status.Phase == "" {
+		rootShard.Status.Phase = operatorkcpiov1alpha1.RootShardPhaseProvisioning
+		if err := r.Client.Status().Update(ctx, &rootShard); err != nil {
+			return ctrl.Result{}, err
+		}
+	}
+
+	ownerRefWrapper := k8creconciling.OwnerRefWrapper(*metav1.NewControllerRef(&rootShard, operatorkcpiov1alpha1.GroupVersion.WithKind(rootShard.Kind)))
+
 	// Intermediate CAs that we need to generate a certificate and an issuer for.
 	intermediateCAs := []v1alpha1.CA{
 		v1alpha1.ServerCA,
@@ -91,32 +111,48 @@ func (r *RootShardReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		certReconcilers = append(certReconcilers, rootshard.RootCACertificateReconciler(&rootShard))
 	}
 
-	if err := reconciling.ReconcileCertificates(ctx, certReconcilers, req.Namespace, r.Client); err != nil {
+	if err := reconciling.ReconcileCertificates(ctx, certReconcilers, req.Namespace, r.Client, ownerRefWrapper); err != nil {
 		return ctrl.Result{}, err
 	}
 
-	if err := reconciling.ReconcileIssuers(ctx, issuerReconcilers, req.Namespace, r.Client); err != nil {
+	if err := reconciling.ReconcileIssuers(ctx, issuerReconcilers, req.Namespace, r.Client, ownerRefWrapper); err != nil {
 		return ctrl.Result{}, err
 	}
 
 	if err := k8creconciling.ReconcileDeployments(ctx, []k8creconciling.NamedDeploymentReconcilerFactory{
 		rootshard.DeploymentReconciler(&rootShard),
-	}, req.Namespace, r.Client); err != nil {
+	}, req.Namespace, r.Client, ownerRefWrapper); err != nil {
 		return ctrl.Result{}, err
 	}
 
 	if err := k8creconciling.ReconcileServices(ctx, []k8creconciling.NamedServiceReconcilerFactory{
 		rootshard.ServiceReconciler(&rootShard),
-	}, req.Namespace, r.Client); err != nil {
+	}, req.Namespace, r.Client, ownerRefWrapper); err != nil {
 		return ctrl.Result{}, err
 	}
 
+	// check for Deployment health and update the rootShard phase if necessary.
+	var dep appsv1.Deployment
+	err := r.Client.Get(ctx, types.NamespacedName{Namespace: req.Namespace, Name: fmt.Sprintf("%s-kcp", rootShard.Name)}, &dep)
+	if client.IgnoreNotFound(err) != nil {
+		return ctrl.Result{}, err
+	}
+	if err == nil {
+		if rootShard.Status.Phase == operatorkcpiov1alpha1.RootShardPhaseProvisioning && dep.Status.ReadyReplicas == ptr.Deref(dep.Spec.Replicas, 0) {
+			rootShard.Status.Phase = operatorkcpiov1alpha1.RootShardPhaseRunning
+			if err := r.Client.Status().Update(ctx, &rootShard); err != nil {
+				return ctrl.Result{}, err
+			}
+		}
+	}
+
 	return ctrl.Result{}, nil
 }
 
 // SetupWithManager sets up the controller with the Manager.
 func (r *RootShardReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&operatorkcpiov1alpha1.RootShard{}).
+		Owns(&appsv1.Deployment{}).
 		Complete(r)
 }

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ type ImageSpec struct {`
`49`	`49`
`50`	`50`	`type RootShardConfig struct {`
`51`	`51`	`// Reference references a local RootShard object.`
`52`		- Reference *corev1.ObjectReference `json:"ref,omitempty"`
	`52`	+ Reference *corev1.LocalObjectReference `json:"ref,omitempty"`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`type EtcdConfig struct {`