Improving Postgres CR Status with Additional Details #2714

RavinaChidambaram · 2024-08-02T13:33:42Z

Following things have been added:

Added observedGeneration
Added conditions of type ReconciliationSuccessful and Ready
Added numberOfInstances and labelSelector for scale subresource
Added scale subresource configuration in the CRD
postgresClusterStatus is still part of the CRD

Detailed example flow:
Conditions are updated everytime there is a change in PostgresClusterStatus. And if the cluster is running successfully, the status looks like:

status:
  conditions:
  - lastTransitionTime: "2024-08-02T12:33:34Z"
    status: "True"
    type: ReconciliationSuccessful
  - lastTransitionTime: "2024-08-02T12:33:34Z"
    status: "True"
    type: Ready
  labelSelector: cluster-name=acid-minimal-cluster
  numberOfInstances: 3
  observedGeneration: 4
  postgresClusterStatus: Running

If there is a transition from Running state to a failed state, type ReconciliationSuccessful will be false.
When a failed case (Create failed,Update failed, Sync failed) is encountered, the error message will be printed in the message in conditions

status:
  conditions:
  - lastTransitionTime: "2024-08-02T13:05:38Z"
    message: 'could not create master endpoint: could not create master endpoint:
      endpoints "acid-minimal-cluster-test-1" already exists'
    reason: CreateFailed
    status: "False"
    type: ReconciliationSuccessful
  - lastTransitionTime: "2024-08-02T13:05:38Z"
    status: "False"
    type: Ready
  labelSelector: cluster-name=acid-minimal-cluster
  numberOfInstances: 0
  postgresClusterStatus: CreateFailed

Signed-off-by: RavinaChidambaram <[email protected]>

RavinaChidambaram · 2024-08-19T06:02:24Z

Hi @FxKu , Is there any update on this PR?

FxKu · 2024-08-23T10:25:45Z

I had to concentrate on the 1.13.0 release. But we will definitely include it in the next release in autumn. This is a great addition. I have to focus on some internal projects for the next weeks, but still, I hope to find some time in between to review.

FxKu · 2024-08-27T09:01:31Z

@RavinaChidambaram can you fix the failing unit test so e2e pipeline can run? There are places where we logged the status assuming it's just a string. Now that it has become a struct you either have to change to %#v when formatting the log lines or specify the PostgresClusterStatus field.

FxKu · 2024-08-27T09:16:38Z

pkg/apis/acid.zalan.do/v1/crds.go

@@ -25,6 +25,12 @@ const (
 	OperatorConfigCRDResourceShort  = "opconfig"
 )

+var (


are these not const?

Changed to const

FxKu · 2024-08-27T09:22:13Z

pkg/apis/acid.zalan.do/v1/postgresql_type.go

+}
+
+// Condition contains the conditions of the PostgreSQL cluster
+type Condition struct {


Can this be changed to PostgresqlCondition? This aligns with other K8s resources.

Yeah, changed to PostgresqlCondition

FxKu · 2024-08-27T09:22:54Z

pkg/apis/acid.zalan.do/v1/postgresql_type.go

@@ -225,9 +226,48 @@ type Sidecar struct {
 // UserFlags defines flags (such as superuser, nologin) that could be assigned to individual users
 type UserFlags []string

+type Conditions []Condition
+
+type ConditionType string


Suggested change

type ConditionType string

type PostgresqlConditionType string

FxKu · 2024-08-27T09:23:53Z

pkg/apis/acid.zalan.do/v1/postgresql_type.go

+type Condition struct {
+	Type               ConditionType      `json:"type" description:"type of status condition"`
+	Status             v1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`
+	LastTransitionTime VolatileTime       `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"`


why use an extra type and not just metav1.Time?

Mostly to avoid semantic check inequality with metav1.time, with a wrapper around metav1.time there won't be a semantic inequality even if the times are different but everything else in the CR is same, this could be handy while writing unit tests or e2e tests I think

FxKu · 2024-08-27T11:53:42Z

pkg/cluster/cluster.go

@@ -255,16 +255,20 @@ func (c *Cluster) Create() (err error) {
 		ss             *appsv1.StatefulSet
 	)

+	//Even though its possible to propogate other CR labels to the pods, picking the default label here since its propogated to all the pods by default. But this means that in order for the scale subresource to work properly, user must set the "cluster-name" key in their CRs with value matching the CR name.
+	labelstring := fmt.Sprintf("%s=%s", "cluster-name", c.Postgresql.ObjectMeta.Labels["cluster-name"]) //TODO: make this configurable.


Labels we propagate to all child resources are configurable with ClusterLabels and ClusterNameLabel. We should use the latter, I think and not hard code it here.

Have changed it, using ClusterNameLabel

FxKu · 2024-08-27T12:04:25Z

pkg/util/k8sutil/k8sutil.go

@@ -192,10 +193,16 @@ func NewFromConfig(cfg *rest.Config) (KubernetesClient, error) {
 }

 // SetPostgresCRDStatus of Postgres cluster
-func (client *KubernetesClient) SetPostgresCRDStatus(clusterName spec.NamespacedName, status string) (*apiacidv1.Postgresql, error) {
+func (client *KubernetesClient) SetPostgresCRDStatus(clusterName spec.NamespacedName, status string, numberOfInstances int32, labelSelector string, observedGeneration int64, existingConditions apiacidv1.Conditions, message string) (*apiacidv1.Postgresql, error) {


Instead of extending the list of arguments we could also pass a PostgresStatus struct, right?

Yeah, made modifications to use the PostgresStatus struct

FxKu · 2024-08-27T15:15:45Z

As half of my comments target the scale subresource, I would suggest to remove it from here and create a separate PR for it. Then you could concentrate only on the status and we get it merged quicker.

Have you tried to run code-generation. I think, the generated code has to get updated with the new status structure.

Signed-off-by: RavinaChidambaram <[email protected]>

RavinaChidambaram · 2024-08-29T13:25:33Z

I have made changes to fix the unit tests and successfully ran code-generation, unit tests and e2e test downstream.
Kindly review the changes and if you still think it's necessary to create a new branch for scale subresource addition, I will proceed with it.

Signed-off-by: RavinaChidambaram <[email protected]>

RavinaChidambaram · 2024-09-12T06:13:46Z

Hi @FxKu , any updates?

RavinaChidambaram added 2 commits August 2, 2024 13:32

changes to postgresql CR status

d89e726

Signed-off-by: RavinaChidambaram <[email protected]>

minor changes

30ed723

Signed-off-by: RavinaChidambaram <[email protected]>

RavinaChidambaram requested review from sdudoladov, Jan-M, FxKu, jopadi, idanovinda, hughcapet and macedigital as code owners August 2, 2024 13:33

FxKu added the minor label Aug 2, 2024

FxKu added this to the 1.14.0 milestone Aug 2, 2024

FxKu reviewed Aug 27, 2024

View reviewed changes

minor changes and fixes for unit test

0269432

Signed-off-by: RavinaChidambaram <[email protected]>

updated zz_generated.deepcopy.go

061b051

Signed-off-by: RavinaChidambaram <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving Postgres CR Status with Additional Details #2714

Improving Postgres CR Status with Additional Details #2714

RavinaChidambaram commented Aug 2, 2024

RavinaChidambaram commented Aug 19, 2024

FxKu commented Aug 23, 2024

FxKu commented Aug 27, 2024 •

edited

Loading

FxKu Aug 27, 2024 •

edited

Loading

RavinaChidambaram Aug 29, 2024

FxKu Aug 27, 2024

RavinaChidambaram Aug 29, 2024

FxKu Aug 27, 2024

FxKu Aug 27, 2024

RavinaChidambaram Aug 29, 2024

FxKu Aug 27, 2024 •

edited

Loading

RavinaChidambaram Aug 29, 2024

FxKu Aug 27, 2024

RavinaChidambaram Aug 29, 2024

FxKu commented Aug 27, 2024

RavinaChidambaram commented Aug 29, 2024

RavinaChidambaram commented Sep 12, 2024

	type ConditionType string
	type PostgresqlConditionType string

Improving Postgres CR Status with Additional Details #2714

Are you sure you want to change the base?

Improving Postgres CR Status with Additional Details #2714

Conversation

RavinaChidambaram commented Aug 2, 2024

RavinaChidambaram commented Aug 19, 2024

FxKu commented Aug 23, 2024

FxKu commented Aug 27, 2024 • edited Loading

FxKu Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FxKu Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FxKu commented Aug 27, 2024

RavinaChidambaram commented Aug 29, 2024

RavinaChidambaram commented Sep 12, 2024

FxKu commented Aug 27, 2024 •

edited

Loading

FxKu Aug 27, 2024 •

edited

Loading

FxKu Aug 27, 2024 •

edited

Loading