EVEREST-1391 DB status details (#502)

percona · Aug 29, 2024 · 671ead7 · 671ead7
1 parent f76543d
commit 671ead7
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 2 deletions.
diff --git a/api/v1alpha1/databasecluster_types.go b/api/v1alpha1/databasecluster_types.go
@@ -357,6 +357,8 @@ type DatabaseClusterStatus struct {
 	// If set, the CR needs to be updated to this version before upgrading the operator.
 	// If unset, the CR is already at the recommended version.
 	RecommendedCRVersion *string `json:"recommendedCRVersion,omitempty"`
+	// Details provides full status of the upstream cluster as a plain text.
+	Details string `json:"details,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/bundle/manifests/everest-operator.clusterserviceversion.yaml b/bundle/manifests/everest-operator.clusterserviceversion.yaml
@@ -103,7 +103,7 @@ metadata:
         }
       ]
     capabilities: Basic Install
-    createdAt: "2024-08-02T09:39:54Z"
+    createdAt: "2024-08-29T09:22:49Z"
     operators.operatorframework.io/builder: operator-sdk-v1.32.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
   name: everest-operator.v0.0.0

diff --git a/bundle/manifests/everest.percona.com_databaseclusters.yaml b/bundle/manifests/everest.percona.com_databaseclusters.yaml
@@ -380,6 +380,10 @@ spec:
                 description: CRVersion is the observed version of the CR used with
                   the underlying operator.
                 type: string
+              details:
+                description: Details provides full status of the upstream cluster
+                  as a plain text.
+                type: string
               hostname:
                 description: Hostname is the hostname where the cluster can be reached
                 type: string

diff --git a/config/crd/bases/everest.percona.com_databaseclusters.yaml b/config/crd/bases/everest.percona.com_databaseclusters.yaml
@@ -380,6 +380,10 @@ spec:
                 description: CRVersion is the observed version of the CR used with
                   the underlying operator.
                 type: string
+              details:
+                description: Details provides full status of the upstream cluster
+                  as a plain text.
+                type: string
               hostname:
                 description: Hostname is the hostname where the cluster can be reached
                 type: string

diff --git a/controllers/common/helper.go b/controllers/common/helper.go
@@ -29,6 +29,7 @@ import (
 	"github.com/AlekSi/pointer"
 	crunchyv1beta1 "github.com/percona/percona-postgresql-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 	psmdbv1 "github.com/percona/percona-server-mongodb-operator/pkg/apis/psmdb/v1"
+	"gopkg.in/yaml.v2"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	storagev1 "k8s.io/api/storage/v1"
@@ -716,3 +717,8 @@ func DefaultAffinitySettings() *corev1.Affinity {
 		},
 	}
 }
+
+func StatusAsPlainTextOrEmptyString(status interface{}) string {
+	result, _ := yaml.Marshal(status)
+	return string(result)
+}
diff --git a/controllers/providers/pg/provider.go b/controllers/providers/pg/provider.go
@@ -105,6 +105,7 @@ func (p *Provider) Status(ctx context.Context) (everestv1alpha1.DatabaseClusterS
 	status.Size = pg.Status.Postgres.Size + pg.Status.PGBouncer.Size
 	status.Port = 5432
 	status.CRVersion = pg.Spec.CRVersion
+	status.Details = common.StatusAsPlainTextOrEmptyString(pg.Status)
 
 	// If a restore is running for this database, set the database status to restoring
 	if restoring, err := common.IsDatabaseClusterRestoreRunning(ctx, c, p.DB.GetName(), p.DB.GetNamespace()); err != nil {

diff --git a/controllers/providers/psmdb/provider.go b/controllers/providers/psmdb/provider.go
@@ -135,6 +135,7 @@ func (p *Provider) Status(ctx context.Context) (everestv1alpha1.DatabaseClusterS
 	status.Port = 27017
 	status.ActiveStorage = activeStorage
 	status.CRVersion = psmdb.Spec.CRVersion
+	status.Details = common.StatusAsPlainTextOrEmptyString(psmdb.Status)
 
 	// If a restore is running for this database, set the database status to restoring.
 	if restoring, err := common.IsDatabaseClusterRestoreRunning(ctx, p.C, p.DB.GetName(), p.DB.GetNamespace()); err != nil {

diff --git a/controllers/providers/pxc/provider.go b/controllers/providers/pxc/provider.go
@@ -217,6 +217,7 @@ func (p *Provider) Status(ctx context.Context) (everestv1alpha1.DatabaseClusterS
 	status.Message = strings.Join(pxc.Status.Messages, ";")
 	status.Port = 3306
 	status.CRVersion = pxc.Spec.CRVersion
+	status.Details = common.StatusAsPlainTextOrEmptyString(pxc.Status)
 
 	// If a restore is running for this database, set the database status to restoring.
 	if restoring, err := common.IsDatabaseClusterRestoreRunning(ctx, p.C, p.DB.GetName(), p.DB.GetNamespace()); err != nil {

diff --git a/deploy/bundle.yaml b/deploy/bundle.yaml
@@ -723,6 +723,9 @@ spec:
               crVersion:
                 description: CRVersion is the observed version of the CR used with the underlying operator.
                 type: string
+              details:
+                description: Details provides full status of the upstream cluster as a plain text.
+                type: string
               hostname:
                 description: Hostname is the hostname where the cluster can be reached
                 type: string

diff --git a/go.mod b/go.mod
@@ -19,6 +19,7 @@ require (
 	github.com/percona/percona-xtradb-cluster-operator v1.15.0
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/mod v0.20.0
+	gopkg.in/yaml.v2 v2.4.0
 	gotest.tools v2.2.0+incompatible
 	k8s.io/api v0.30.3
 	k8s.io/apimachinery v0.30.3
@@ -121,7 +122,6 @@ require (
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/protobuf v1.34.1 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiextensions-apiserver v0.30.1 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect