Backup restore

.gitignore

@@ -48,7 +48,7 @@ testbin/*
 *~
 
 # Omit some fully generated files
-config/crd/bases/vertica.com_verticadbs.yaml
+config/crd/bases/*.yaml
 config/rbac/role.yaml
 api/v1beta1/zz_generated.deepcopy.go
 

PROJECT

@@ -19,4 +19,15 @@ resources:
     defaulting: true
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: vertica.com
+  kind: VerticaAutoscaler
+  path: github.com/vertica/vertica-kubernetes/api/v1beta1
+  version: v1beta1
+  webhooks:
+    validation: true
+    webhookVersion: v1
 version: "3"

api/v1beta1/groupversion_info.go

@@ -24,9 +24,17 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
 )
 
+const (
+	Group   = "vertica.com"
+	Version = "v1beta1"
+
+	VerticaDBKind         = "VerticaDB"
+	VerticaAutoscalerKind = "VerticaAutoscaler"
+)
+
 var (
 	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "vertica.com", Version: "v1beta1"}
+	GroupVersion = schema.GroupVersion{Group: Group, Version: Version}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

api/v1beta1/verticaarchive_types.go

@@ -0,0 +1,71 @@
+/*
+Copyright [2021-2022] Micro Focus or one of its affiliates.
+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 v1beta1
+
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+const VerticaArchiveKind = "VerticaArchive"
+
+// VerticaArchiveSpec defines the desired state of VerticaArchive
+type VerticaArchiveSpec struct {
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// The path where the archive is stored. This parameter is required.
+	// For S3-compatible or cloud locations, provide the bucket name and backup path.
+	// For HDFS locations, provide the appropriate protocol and backup path.
+	Path string `json:"path,omitempty"`
+
+	// +kubebuilder:default:=1
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:number"
+	// Number of earlier backups to retain with the most recent backup.
+	// If set to 1 (the default), we maintains two backups: the latest backup and the one before it
+	RestorePointLimit int `json:"restorePointLimit"`
+}
+
+// VerticaArchiveStatus defines the observed state of VerticaArchive
+type VerticaArchiveStatus struct {
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// The number of backups existing in  the archive.
+	BackupCount int `json:"backupCount"`
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:resource:categories=all;vertica,shortName=va
+//+kubebuilder:subresource:status
+//+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+//+kubebuilder:printcolumn:name="Backup Count",type="integer",JSONPath=".status.backupCount"
+
+// VerticaArchive is the schema for verticaarchives API
+type VerticaArchive struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   VerticaArchiveSpec   `json:"spec,omitempty"`
+	Status VerticaArchiveStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// VerticaArchiveList contains a list of VerticaArchive
+type VerticaArchiveList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []VerticaArchive `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&VerticaArchive{}, &VerticaArchiveList{})
+}

api/v1beta1/verticaautoscaler_types.go

@@ -0,0 +1,200 @@
+/*
+Copyright [2021-2022] Micro Focus or one of its affiliates.
+
+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.
+*/
+
+// nolint:lll
+package v1beta1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+// VerticaAutoscalerSpec defines the desired state of VerticaAutoscaler
+type VerticaAutoscalerSpec struct {
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
+	// The name of the VerticaDB CR that this autoscaler is defined for.  The
+	// VerticaDB object must exist in the same namespace as this object.
+	VerticaDBName string `json:"verticaDBName,omitempty"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +kubebuilder:default:="Subcluster"
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:select:Pod","urn:alm:descriptor:com.tectonic.ui:select:Subcluster"}
+	// This defines how the scaling will happen.  This can be one of the following:
+	// - Subcluster: Scaling will be achieved by creating or deleting entire subclusters.
+	//   The template for new subclusters are either the template if filled out
+	//   or an existing subcluster that matches the service name.
+	// - Pod: Only increase or decrease the size of an existing subcluster.
+	//   If multiple subclusters are selected by the serviceName, this will grow
+	//   the last subcluster only.
+	ScalingGranularity ScalingGranularityType `json:"scalingGranularity"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
+	// This acts as a selector for the subclusters that are being scaled together.
+	// Each subcluster has a service name field, which if omitted is the same
+	// name as the subcluster name.  Multiple subclusters that have the same
+	// service name use the same service object.
+	ServiceName string `json:"serviceName"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +kubebuilder:validation:Optional
+	// When the scaling granularity is Subcluster, this field defines a template
+	// to use for when a new subcluster needs to be created.  If size is 0, then
+	// the operator will use an existing subcluster to use as the template.  If
+	// size is > 0, the service name must match the serviceName parameter.  The
+	// name of the new subcluster is always auto generated.  If the name is set
+	// here it will be used as a prefix for the new subcluster.  Otherwise, we
+	// use the name of this VerticaAutoscaler object as a prefix for all
+	// subclusters.
+	Template Subcluster `json:"template"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:podCount"
+	// This is the total pod count for all subclusters that match the
+	// serviceName.  Changing this value may trigger a change in the
+	// VerticaDB that is associated with this object.  This value is generally
+	// left as zero.  It will get initialized in the operator and then modified
+	// via the /scale subresource.
+	TargetSize int32 `json:"targetSize"`
+}
+
+type ScalingGranularityType string
+
+const (
+	PodScalingGranularity        = "Pod"
+	SubclusterScalingGranularity = "Subcluster"
+)
+
+// VerticaAutoscalerStatus defines the observed state of VerticaAutoscaler
+type VerticaAutoscalerStatus struct {
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// The total number of times the operator has scaled up/down the VerticaDB.
+	ScalingCount int `json:"scalingCount"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// The observed size of all pods that are routed through the service name.
+	CurrentSize int32 `json:"currentSize"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// The selector used to find all of the pods for this autoscaler.
+	Selector string `json:"selector"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// Conditions for VerticaAutoscaler
+	Conditions []VerticaAutoscalerCondition `json:"conditions,omitempty"`
+}
+
+// VerticaAutoscalerCondition defines condition for VerticaAutoscaler
+type VerticaAutoscalerCondition struct {
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// Type is the type of the condition
+	Type VerticaAutoscalerConditionType `json:"type"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// Status is the status of the condition
+	// can be True, False or Unknown
+	Status corev1.ConditionStatus `json:"status"`
+
+	// +operator-sdk:csv:customresourcedefinitions:type=status
+	// Last time the condition transitioned from one status to another.
+	// +optional
+	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
+}
+
+type VerticaAutoscalerConditionType string
+
+const (
+	// TargetSizeInitialized indicates whether the operator has initialized targetSize in the spec
+	TargetSizeInitialized VerticaAutoscalerConditionType = "TargetSizeInitialized"
+)
+
+// Fixed index entries for each condition.
+const (
+	TargetSizeInitializedIndex = iota
+)
+
+//+kubebuilder:object:root=true
+//+kubebuilder:resource:categories=all;vertica,shortName=vas
+//+kubebuilder:subresource:status
+//+kubebuilder:subresource:scale:specpath=.spec.targetSize,statuspath=.status.currentSize,selectorpath=.status.selector
+//+kubebuilder:printcolumn:name="Granularity",type="string",JSONPath=".spec.scalingGranularity"
+//+kubebuilder:printcolumn:name="Current Size",type="integer",JSONPath=".status.currentSize"
+//+kubebuilder:printcolumn:name="Target Size",type="integer",JSONPath=".spec.targetSize"
+//+kubebuilder:printcolumn:name="Scaling Count",type="integer",JSONPath=".status.scalingCount"
+//+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+//+operator-sdk:csv:customresourcedefinitions:resources={{VerticaDB,vertica.com/v1beta1,""}}
+
+// VerticaAutoscaler is the Schema for the verticaautoscalers API
+type VerticaAutoscaler struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   VerticaAutoscalerSpec   `json:"spec,omitempty"`
+	Status VerticaAutoscalerStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// VerticaAutoscalerList contains a list of VerticaAutoscaler
+type VerticaAutoscalerList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []VerticaAutoscaler `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&VerticaAutoscaler{}, &VerticaAutoscalerList{})
+}
+
+// MakeVASName is a helper that creates a sample name for test purposes
+func MakeVASName() types.NamespacedName {
+	return types.NamespacedName{Name: "vertica-vas-sample", Namespace: "default"}
+}
+
+// MakeVAS is a helper that constructs a fully formed VerticaAutoscaler struct using the sample name.
+// This is intended for test purposes.
+func MakeVAS() *VerticaAutoscaler {
+	vasNm := MakeVASName()
+	vdbNm := MakeVDBName()
+	return &VerticaAutoscaler{
+		TypeMeta: metav1.TypeMeta{
+			APIVersion: GroupVersion.String(),
+			Kind:       VerticaAutoscalerKind,
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:        vasNm.Name,
+			Namespace:   vasNm.Namespace,
+			UID:         "abcdef-ghi",
+			Annotations: make(map[string]string),
+		},
+		Spec: VerticaAutoscalerSpec{
+			VerticaDBName:      vdbNm.Name,
+			ScalingGranularity: "Pod",
+			ServiceName:        "sc1",
+		},
+	}
+}
+
+// CanUseTemplate returns true if we can use the template provided in the spec
+func (v *VerticaAutoscaler) CanUseTemplate() bool {
+	return v.Spec.Template.Size > 0
+}