feat: declarative publications and subscriptions

.wordlist-en-custom.txt

@@ -338,6 +338,12 @@ PrimaryUpdateStrategy
 PriorityClass
 PriorityClassName
 ProjectedVolumeSource
+PublicationReclaimPolicy
+PublicationSpec
+PublicationStatus
+PublicationTarget
+PublicationTargetAllTables
+PublicationTargetObject
 PullPolicy
 QoS
 Quaresima
@@ -423,6 +429,9 @@ StatefulSets
 StorageClass
 StorageConfiguration
 Storages
+SubscriptionReclaimPolicy
+SubscriptionSpec
+SubscriptionStatus
 SuccessfullyExtracted
 SwitchReplicaClusterStatus
 SyncReplicaElectionConstraints
@@ -492,6 +501,7 @@ addons
 affinityconfiguration
 aks
 albert
+allTables
 allnamespaces
 alloc
 allocator
@@ -736,6 +746,7 @@ executables
 expirations
 extensibility
 externalCluster
+externalClusterName
 externalClusterSecretVersion
 externalClusters
 externalclusters
@@ -1056,6 +1067,10 @@ promotionTimeout
 promotionToken
 provisioner
 psql
+publicate
+publicated
+publicationName
+publicationReclaimPolicy
 pv
 pvc
 pvcCount
@@ -1200,6 +1215,7 @@ subcommand
 subcommands
 subdirectory
 subresource
+subscriptionReclaimPolicy
 substatement
 successfullyExtracted
 sudo
@@ -1218,6 +1234,7 @@ syslog
 systemd
 sysv
 tAc
+tableExpression
 tablespace
 tablespaceClassName
 tablespaceMapFile

PROJECT

@@ -66,3 +66,21 @@ resources:
   kind: Database
   path: github.com/cloudnative-pg/cloudnative-pg/api/v1
   version: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: cnpg.io
+  group: postgresql
+  kind: Publication
+  path: github.com/cloudnative-pg/cloudnative-pg/api/v1
+  version: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: cnpg.io
+  group: postgresql
+  kind: Subscription
+  path: github.com/cloudnative-pg/cloudnative-pg/api/v1
+  version: v1

api/v1/publication_funcs.go

@@ -0,0 +1,30 @@
+/*
+Copyright The CloudNativePG Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+// SetAsFailed sets the publication as failed with the given error
+func (pub *Publication) SetAsFailed(err error) {
+	pub.Status.Ready = false
+	pub.Status.Error = err.Error()
+}
+
+// SetAsReady sets the subscription as working correctly
+func (pub *Publication) SetAsReady() {
+	pub.Status.Error = ""
+	pub.Status.Ready = true
+	pub.Status.ObservedGeneration = pub.Generation
+}

api/v1/publication_types.go

@@ -0,0 +1,128 @@
+/*
+Copyright The CloudNativePG Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// PublicationReclaimPolicy describes a policy for end-of-life maintenance of Publications.
+// +enum
+type PublicationReclaimPolicy string
+
+const (
+	// PublicationReclaimDelete means the publication will be deleted from Kubernetes on release
+	// from its claim.
+	PublicationReclaimDelete PublicationReclaimPolicy = "delete"
+
+	// PublicationReclaimRetain means the publication will be left in its current phase for manual
+	// reclamation by the administrator. The default policy is Retain.
+	PublicationReclaimRetain PublicationReclaimPolicy = "retain"
+)
+
+// PublicationSpec defines the desired state of Publication
+type PublicationSpec struct {
+	// The corresponding cluster
+	ClusterRef corev1.LocalObjectReference `json:"cluster"`
+
+	// The name inside PostgreSQL
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="name is immutable"
+	Name string `json:"name"`
+
+	// The name of the database
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="dbname is immutable"
+	DBName string `json:"dbname"`
+
+	// The owner
+	Owner string `json:"owner,omitempty"`
+
+	// Parameters
+	Parameters map[string]string `json:"parameters,omitempty"`
+
+	// Publication target
+	Target PublicationTarget `json:"target,omitempty"`
+
+	// The policy for end-of-life maintenance of this publication
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=retain
+	// +optional
+	ReclaimPolicy PublicationReclaimPolicy `json:"publicationReclaimPolicy,omitempty"`
+}
+
+// PublicationTarget is what this publication should publish
+// +kubebuilder:validation:XValidation:rule="(has(self.allTables) && !has(self.objects)) || (!has(self.allTables) && has(self.objects))",message="allTables and objects are not compatible"
+type PublicationTarget struct {
+	// All tables should be publicated
+	AllTables bool `json:"allTables,omitempty"`
+
+	// Just the following schema objects
+	Objects []PublicationTargetObject `json:"objects,omitempty"`
+}
+
+// PublicationTargetObject is an object to publicate
+type PublicationTargetObject struct {
+	// The schema to publicate
+	Schema string `json:"schema,omitempty"`
+
+	// A list of table expressions
+	TableExpression []string `json:"tableExpression,omitempty"`
+}
+
+// PublicationStatus defines the observed state of Publication
+type PublicationStatus struct {
+	// A sequence number representing the latest
+	// desired state that was synchronized
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+
+	// Ready is true if the database was reconciled correctly
+	Ready bool `json:"ready,omitempty"`
+
+	// Error is the reconciliation error message
+	Error string `json:"error,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+// +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".spec.cluster.name"
+// +kubebuilder:printcolumn:name="PG Name",type="string",JSONPath=".spec.name"
+// +kubebuilder:printcolumn:name="Ready",type="boolean",JSONPath=".status.ready"
+// +kubebuilder:printcolumn:name="Error",type="string",JSONPath=".status.error",description="Latest error message"
+
+// Publication is the Schema for the publications API
+type Publication struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   PublicationSpec   `json:"spec"`
+	Status PublicationStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// PublicationList contains a list of Publication
+type PublicationList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Publication `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Publication{}, &PublicationList{})
+}

api/v1/subscription_funcs.go

@@ -0,0 +1,30 @@
+/*
+Copyright The CloudNativePG Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+// SetAsFailed sets the subscription as failed with the given error
+func (sub *Subscription) SetAsFailed(err error) {
+	sub.Status.Ready = false
+	sub.Status.Error = err.Error()
+}
+
+// SetAsReady sets the subscription as working correctly
+func (sub *Subscription) SetAsReady() {
+	sub.Status.Error = ""
+	sub.Status.Ready = true
+	sub.Status.ObservedGeneration = sub.Generation
+}

api/v1/subscription_types.go

@@ -0,0 +1,113 @@
+/*
+Copyright The CloudNativePG Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// SubscriptionReclaimPolicy describes a policy for end-of-life maintenance of Subscriptions.
+// +enum
+type SubscriptionReclaimPolicy string
+
+const (
+	// SubscriptionReclaimDelete means the subscription will be deleted from Kubernetes on release
+	// from its claim.
+	SubscriptionReclaimDelete SubscriptionReclaimPolicy = "delete"
+
+	// SubscriptionReclaimRetain means the subscription will be left in its current phase for manual
+	// reclamation by the administrator. The default policy is Retain.
+	SubscriptionReclaimRetain SubscriptionReclaimPolicy = "retain"
+)
+
+// SubscriptionSpec defines the desired state of Subscription
+type SubscriptionSpec struct {
+	// The corresponding cluster
+	ClusterRef corev1.LocalObjectReference `json:"cluster"`
+
+	// The name inside PostgreSQL
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="name is immutable"
+	Name string `json:"name"`
+
+	// The owner
+	Owner string `json:"owner,omitempty"`
+
+	// The name of the database
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="dbname is immutable"
+	DBName string `json:"dbname"`
+
+	// Parameters
+	// +optional
+	Parameters map[string]string `json:"parameters,omitempty"`
+
+	// The name of the publication
+	PublicationName string `json:"publicationName"`
+
+	// The name of the external cluster with the publication
+	ExternalClusterName string `json:"externalClusterName"`
+
+	// The policy for end-of-life maintenance of this subscription
+	// +kubebuilder:validation:Enum=delete;retain
+	// +kubebuilder:default:=retain
+	// +optional
+	ReclaimPolicy SubscriptionReclaimPolicy `json:"subscriptionReclaimPolicy,omitempty"`
+}
+
+// SubscriptionStatus defines the observed state of Subscription
+type SubscriptionStatus struct {
+	// A sequence number representing the latest
+	// desired state that was synchronized
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+
+	// Ready is true if the database was reconciled correctly
+	Ready bool `json:"ready,omitempty"`
+
+	// Error is the reconciliation error message
+	Error string `json:"error,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+// +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".spec.cluster.name"
+// +kubebuilder:printcolumn:name="PG Name",type="string",JSONPath=".spec.name"
+// +kubebuilder:printcolumn:name="Ready",type="boolean",JSONPath=".status.ready"
+// +kubebuilder:printcolumn:name="Error",type="string",JSONPath=".status.error",description="Latest error message"
+
+// Subscription is the Schema for the subscriptions API
+type Subscription struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   SubscriptionSpec   `json:"spec"`
+	Status SubscriptionStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// SubscriptionList contains a list of Subscription
+type SubscriptionList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Subscription `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Subscription{}, &SubscriptionList{})
+}