Merge branch 'main' of https://github.com/fi-ts/postgreslet into refactor-nextFreeSocket

Author: eberlep

api/v1/postgres_types.go

@@ -8,7 +8,7 @@ package v1
 
 import (
 	"fmt"
-	"time"
+	"reflect"
 
 	"regexp"
 
@@ -18,6 +18,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/intstr"
@@ -28,57 +29,67 @@ import (
 // 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.
 
+const (
+	// UIDLabelName Name of the label referencing the owning Postgres resource in the control cluster
+	UIDLabelName string = "postgres.database.fits.cloud/uuid"
+	// TenantLabelName Name of the tenant label
+	TenantLabelName string = "postgres.database.fits.cloud/tenant"
+	// ProjectIDLabelName Name of the ProjectID label
+	ProjectIDLabelName string = "postgres.database.fits.cloud/project-id"
+	// ManagedByLabelName Name of the managed-by label
+	ManagedByLabelName string = "postgres.database.fits.cloud/managed-by"
+	// ManagedByLabelValue Value of the managed-by label
+	ManagedByLabelValue string = "postgreslet"
+	// PostgresFinalizerName Name of the finalizer to use
+	PostgresFinalizerName string = "postgres.finalizers.database.fits.cloud"
+	// CreatedByAnnotationKey is used to store who in person created this database
+	CreatedByAnnotationKey string = "postgres.database.fits.cloud/created-by"
+	// BackupConfigLabelName if set to true, this secret stores the backupConfig
+	BackupConfigLabelName string = "postgres.database.fits.cloud/is-backup"
+	// BackupConfigKey defines the key under which the BackupConfig is stored in the data map.
+	BackupConfigKey = "config"
+)
+
+// BackupConfig defines all properties to configure backup of a database.
+// This config is stored in the data section under the key BackupConfigKey as json payload.
+type BackupConfig struct {
+	// ID of this backupConfig
+	ID string `json:"id"`
+	// Name is a user defined description
+	Name string `json:"name"`
+	// ProjectID the project this backup is mapped to
+	ProjectID string `json:"project"`
+	// Tenant the tenant of the backup
+	Tenant string `json:"tenant"`
+	// Retention defines how many versions should be held in s3
+	Retention string `json:"retention"`
+	// Schedule in cron syntax when to run the backup periodically
+	Schedule string `json:"schedule"`
+
+	// S3Endpoint the url of the s3 endpoint
+	S3Endpoint string `json:"s3endpoint"`
+	// S3BucketName is the name of the bucket where the backup should be stored.
+	S3BucketName string `json:"s3bucketname"`
+	// S3Region the region of the aws s3
+	S3Region string `json:"s3region"`
+	// S3AccessKey is the accesskey which must have write access
+	S3AccessKey string `json:"s3accesskey"`
+	// S3SecretKey is the secretkey which must match to the accesskey
+	S3SecretKey string `json:"s3secretkey"`
+}
+
+var ZalandoPostgresqlTypeMeta = metav1.TypeMeta{
+	APIVersion: "acid.zalan.do/v1",
+	Kind:       "postgresql",
+}
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Version",type=string,JSONPath=`.spec.version`
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.description`
 // +kubebuilder:printcolumn:name="Load-Balancer-IP",type=string,JSONPath=`.status.socket.ip`
 // +kubebuilder:printcolumn:name="Load-Balancer-Port",type=integer,JSONPath=`.status.socket.port`
 
-// UIDLabelName Name of the label referencing the owning Postgres resource in the control cluster
-const UIDLabelName string = "postgres.database.fits.cloud/uuid"
-
-// TenantLabelName Name of the tenant label
-const TenantLabelName string = "postgres.database.fits.cloud/tenant"
-
-// ProjectIDLabelName Name of the ProjectID label
-const ProjectIDLabelName string = "postgres.database.fits.cloud/project-id"
-
-// ManagedByLabelName Name of the managed-by label
-const ManagedByLabelName string = "postgres.database.fits.cloud/managed-by"
-
-// ManagedByLabelValue Value of the managed-by label
-const ManagedByLabelValue string = "postgreslet"
-
-// PostgresFinalizerName Name of the finalizer to use
-const PostgresFinalizerName string = "postgres.finalizers.database.fits.cloud"
-
-// Backup configure parametes of the database backup
-const (
-	// S3URL defines the s3 endpoint URL for backup
-	BackupSecretS3Endpoint = "s3Endpoint"
-	// S3BucketName defines the name of the S3 bucket for backup
-	BackupSecretS3BucketName = "s3BucketName"
-	// Retention defines how many days a backup will persist
-	BackupSecretRetention = "retention"
-	// Schedule defines how often a backup should be made, in cron format
-	BackupSecretSchedule   = "schedule"
-	BackupSecretAccessKey  = "accesskey"
-	BackupSecretSecretKey  = "secretkey"
-	BackupSecretProjectKey = "project"
-)
-
-const (
-	Sun Weekday = iota
-	Mon
-	Tue
-	Wed
-	Thu
-	Fri
-	Sat
-	All
-)
-
 // Postgres is the Schema for the postgres API
 type Postgres struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -117,7 +128,7 @@ type PostgresSpec struct {
 
 	// todo: add default
 	// Maintenance defines automatic maintenance of the database
-	Maintenance *Maintenance `json:"maintenance,omitempty"`
+	Maintenance []string `json:"maintenance,omitempty"`
 
 	// AccessList defines access restrictions
 	AccessList *AccessList `json:"accessList,omitempty"`
@@ -132,6 +143,7 @@ type AccessList struct {
 	SourceRanges []string `json:"sourceRanges,omitempty"`
 }
 
+// Todo: Add defaults
 // Size defines the size aspects of the database
 type Size struct {
 	// CPU is in the format as pod.spec.resource.request.cpu
@@ -147,23 +159,6 @@ type Size struct {
 	StorageSize string `json:"storageSize,omitempty"`
 }
 
-// Weekday defines a weekday or everyday
-type Weekday int
-
-// TimeWindow defines an interval in time
-type TimeWindow struct {
-	Start metav1.Time `json:"start,omitempty"`
-	End   metav1.Time `json:"end,omitempty"`
-}
-
-// Maintenance configures database maintenance
-type Maintenance struct {
-	// Weekday defines when the operator is allowed to do maintenance
-	Weekday Weekday `json:"weekday,omitempty"`
-	// TimeWindow defines when the maintenance should happen
-	TimeWindow TimeWindow `json:"timeWindow,omitempty"`
-}
-
 // PostgresStatus defines the observed state of Postgres
 type PostgresStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
@@ -307,7 +302,7 @@ func (p *Postgres) ToPeripheralResourceName() string {
 	return p.generateTeamID() + "-" + p.generateDatabaseName()
 }
 
-// ToUserPasswordSecret returns the secret containing user password pairs
+// ToUserPasswordsSecret returns the secret containing user password pairs
 func (p *Postgres) ToUserPasswordsSecret(src *corev1.SecretList, scheme *runtime.Scheme) (*corev1.Secret, error) {
 	secret := &corev1.Secret{}
 	secret.Namespace = p.Namespace
@@ -384,99 +379,63 @@ func (p *Postgres) ToPeripheralResourceNamespace() string {
 	return p.ToPeripheralResourceName()
 }
 
-func (p *Postgres) ToZalandoPostgres() *ZalandoPostgres {
-	return &ZalandoPostgres{
-		TypeMeta: ZalandoPostgresTypeMeta,
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      p.ToPeripheralResourceName(),
-			Namespace: p.ToPeripheralResourceNamespace(),
-			Labels:    map[string]string{UIDLabelName: string(p.UID)},
-		},
-		Spec: ZalandoPostgresSpec{
-			MaintenanceWindows: func() []MaintenanceWindow {
-				if p.Spec.Maintenance == nil {
-					return nil
-				}
-				isEvery := p.Spec.Maintenance.Weekday == All
-				return []MaintenanceWindow{
-					{Everyday: isEvery,
-						Weekday: func() time.Weekday {
-							if isEvery {
-								return time.Weekday(0)
-							}
-							return time.Weekday(p.Spec.Maintenance.Weekday)
-						}(),
-						StartTime: p.Spec.Maintenance.TimeWindow.Start,
-						EndTime:   p.Spec.Maintenance.TimeWindow.End,
-					},
-				}
-			}(),
-			NumberOfInstances: p.Spec.NumberOfInstances,
-			PostgresqlParam:   PostgresqlParam{PgVersion: p.Spec.Version},
-			Resources: func() *Resources {
-				if p.Spec.Size.CPU == "" {
-					return nil
-				}
-				return &Resources{
-					ResourceRequests: &ResourceDescription{
-						CPU:    p.Spec.Size.CPU,
-						Memory: p.Spec.Size.Memory,
-					},
-					ResourceLimits: &ResourceDescription{
-						CPU:    p.Spec.Size.CPU,
-						Memory: p.Spec.Size.Memory,
-					},
-				}
-			}(),
-			TeamID: p.generateTeamID(),
-			Volume: Volume{Size: p.Spec.Size.StorageSize},
-		},
+func (p *Postgres) ToUnstructuredZalandoPostgresql(z *zalando.Postgresql) (*unstructured.Unstructured, error) {
+	if z == nil {
+		z = &zalando.Postgresql{}
 	}
-}
+	z.TypeMeta = ZalandoPostgresqlTypeMeta
+	z.Namespace = p.ToPeripheralResourceNamespace()
+	z.Name = p.ToPeripheralResourceName()
+	z.Labels = p.ToZalandoPostgresqlMatchingLabels()
+
+	z.Spec.NumberOfInstances = p.Spec.NumberOfInstances
+	z.Spec.PostgresqlParam.PgVersion = p.Spec.Version
+	z.Spec.Resources.ResourceRequests.CPU = p.Spec.Size.CPU
+	z.Spec.Resources.ResourceRequests.Memory = p.Spec.Size.Memory
+	z.Spec.Resources.ResourceLimits.CPU = p.Spec.Size.CPU
+	z.Spec.Resources.ResourceLimits.Memory = p.Spec.Size.Memory
+	z.Spec.TeamID = p.generateTeamID()
+	z.Spec.Volume.Size = p.Spec.Size.StorageSize
 
-func (p *Postgres) ToPatchedZalandoPostgresql(z *zalando.Postgresql) *zalando.Postgresql {
 	if p.HasSourceRanges() {
 		z.Spec.AllowedSourceRanges = p.Spec.AccessList.SourceRanges
 	}
 
-	z.Spec.NumberOfInstances = p.Spec.NumberOfInstances
-
-	// todo: Check if the validation should be performed here.
-	z.Spec.PostgresqlParam.PgVersion = p.Spec.Version
+	jsonZ, err := runtime.DefaultUnstructuredConverter.ToUnstructured(z)
+	if err != nil {
+		return nil, fmt.Errorf("failed to convert to unstructured zalando postgresql: %w", err)
+	}
+	jsonSpec, _ := jsonZ["spec"].(map[string]interface{})
 
-	z.Spec.ResourceRequests.CPU = p.Spec.Size.CPU
-	z.Spec.ResourceRequests.Memory = p.Spec.Size.Memory
-	z.Spec.ResourceLimits.CPU = p.Spec.Size.CPU
-	z.Spec.ResourceLimits.Memory = p.Spec.Size.Memory
+	// In the code, zalando's `MaintenanceWindows` is a `struct`, but in the CRD
+	// it's an array of strings, so we can only set its `Unstructured` contents
+	// and deal with possible `nil`.
+	jsonSpec["maintenanceWindows"] = p.Spec.Maintenance
+	deleteIfEmpty(jsonSpec, "maintenanceWindows")
 
-	// todo: Check if the validation should be performed here.
-	z.Spec.Volume.Size = p.Spec.Size.StorageSize
+	// Delete unused fields
+	deleteIfEmpty(jsonSpec, "clone")
+	deleteIfEmpty(jsonSpec, "patroni") // if in use, deleteIfEmpty needs to consider the case of struct.
+	deleteIfEmpty(jsonSpec, "podAnnotations")
+	deleteIfEmpty(jsonSpec, "serviceAnnotations")
+	deleteIfEmpty(jsonSpec, "standby")
+	deleteIfEmpty(jsonSpec, "tls")
+	deleteIfEmpty(jsonSpec, "users")
 
-	z.Spec.MaintenanceWindows = func() []zalando.MaintenanceWindow {
-		if p.Spec.Maintenance == nil {
-			return nil
-		}
-		isEvery := p.Spec.Maintenance.Weekday == All
-		return []zalando.MaintenanceWindow{
-			{
-				Everyday: isEvery,
-				Weekday: func() time.Weekday {
-					if isEvery {
-						return time.Weekday(0)
-					}
-					return time.Weekday(p.Spec.Maintenance.Weekday)
-				}(),
-				StartTime: p.Spec.Maintenance.TimeWindow.Start,
-				EndTime:   p.Spec.Maintenance.TimeWindow.End,
-			},
-		}
-	}()
+	jsonP, _ := jsonSpec["postgresql"].(map[string]interface{})
+	deleteIfEmpty(jsonP, "parameters")
 
-	return z
+	return &unstructured.Unstructured{
+		Object: jsonZ,
+	}, nil
 }
 
 func (p *Postgres) ToZalandoPostgresqlMatchingLabels() client.MatchingLabels {
-	return client.MatchingLabels{UIDLabelName: string(p.UID)}
+	return client.MatchingLabels{
+		ProjectIDLabelName: p.Spec.PartitionID,
+		TenantLabelName:    p.Spec.Tenant,
+		UIDLabelName:       string(p.UID),
+	}
 }
 
 func (p *Postgres) HasFinalizer(finalizerName string) bool {
@@ -510,6 +469,15 @@ func removeElem(ss []string, s string) (out []string) {
 	return
 }
 
+func deleteIfEmpty(json map[string]interface{}, key string) {
+	i := json[key]
+
+	// interface has type and value. The chained function calls deal with nil value with type.
+	if i == nil || reflect.ValueOf(json[key]).IsNil() {
+		delete(json, key)
+	}
+}
+
 func init() {
 	SchemeBuilder.Register(&Postgres{}, &PostgresList{})
 }