add TopologySpreadConstraints, add Database.Spec.Path, add skip-initialization annotation (#109)

* add TopologySpreadConstraints, add Database.Spec.Path, add Database skip-initialize annotation

* fix style, split webhook config

* use patch-validating

* fix issues, fix make test and add make clean targets

Author: artgromov

Makefile

@@ -59,9 +59,16 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
-test: manifests generate fmt vet envtest ## Run tests.
+test: manifests generate fmt vet envtest docker-build ## Run tests.
+	kind create cluster --config e2e/kind-cluster-config.yaml --name kind-ydb-operator
+	docker tag cr.yandex/yc/ydb-operator:latest kind/ydb-operator:current
+	kind load docker-image cr.yandex/yc/ydb-operator:latest --name kind-ydb-operator
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
 
+.PHONY: clean
+clean:
+	kind delete cluster --name kind-ydb-operator
+
 ##@ Build
 
 build: generate fmt vet ## Build manager binary.
@@ -70,7 +77,7 @@ build: generate fmt vet ## Build manager binary.
 run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./cmd/ydb-kubernetes-operator/main.go
 
-docker-build: test ## Build docker image with the manager.
+docker-build: ## Build docker image with the manager.
 	docker build -t ${IMG} .
 
 docker-push: ## Push docker image with the manager.

api/v1alpha1/const.go

@@ -32,6 +32,8 @@ const (
 	DaemonBinaryName = "ydbd"
 
 	TenantNameFormat = "/%s/%s"
+
+	AnnotationSkipInitialization = "ydb.tech/skip-initialization"
 )
 
 type ErasureType string

api/v1alpha1/database_types.go

@@ -40,6 +40,13 @@ type DatabaseSpec struct {
 	// +optional
 	Domain string `json:"domain"`
 
+	// (Optional) Custom database path in schemeshard
+	// Default: /<spec.domain>/<metadata.name>
+	// +kubebuilder:validation:Pattern:=/[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?/[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?(/[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?)*
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	Path string `json:"path,omitempty"`
+
 	// (Optional) Database storage and compute resources
 	// +optional
 	Resources *DatabaseResources `json:"resources,omitempty"` // TODO: Add validation webhook: some resources must be specified
@@ -101,6 +108,16 @@ type DatabaseSpec struct {
 	// +optional
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
 
+	// (Optional) If specified, the pod's topologySpreadConstraints.
+	// All topologySpreadConstraints are ANDed.
+	// +optional
+	// +patchMergeKey=topologyKey
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=topologyKey
+	// +listMapKey=whenUnsatisfiable
+	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty" patchStrategy:"merge" patchMergeKey:"topologyKey"`
+
 	// (Optional) Additional custom resource labels that are added to all resources
 	// +optional
 	AdditionalLabels map[string]string `json:"additionalLabels,omitempty"`

api/v1alpha1/database_webhook.go

@@ -3,6 +3,7 @@ package v1alpha1
 import (
 	"errors"
 	"fmt"
+	"strings"
 
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -24,6 +25,10 @@ func (r *Database) SetupWebhookWithManager(mgr ctrl.Manager) error {
 
 var _ webhook.Defaulter = &Database{}
 
+func GetDatabasePath(r *Database) string {
+	return fmt.Sprintf(TenantNameFormat, r.Spec.Domain, r.Name) // FIXME: review later in context of multiple namespaces
+}
+
 // Default implements webhook.Defaulter so a webhook will be registered for the type
 func (r *Database) Default() {
 	databaselog.Info("default", "name", r.Name)
@@ -63,7 +68,11 @@ func (r *Database) Default() {
 	}
 
 	if r.Spec.Domain == "" {
-		r.Spec.Domain = DefaultDatabaseDomain // FIXME
+		r.Spec.Domain = DefaultDatabaseDomain // FIXME: default domain should be "Root", not "root"
+	}
+
+	if r.Spec.Path == "" {
+		r.Spec.Path = GetDatabasePath(r)
 	}
 
 	if r.Spec.Encryption == nil {
@@ -89,6 +98,12 @@ var _ webhook.Validator = &Database{}
 func (r *Database) ValidateCreate() error {
 	databaselog.Info("validate create", "name", r.Name)
 
+	if r.Spec.Domain != "" && r.Spec.Path != "" {
+		if !strings.HasPrefix(r.Spec.Path, fmt.Sprintf("/%s", r.Spec.Domain)) {
+			return fmt.Errorf("incorrect database path, must start with domain: \"/%s\"", r.Spec.Domain)
+		}
+	}
+
 	if r.Spec.Resources == nil && r.Spec.SharedResources == nil && r.Spec.ServerlessResources == nil {
 		return errors.New("incorrect database resources configuration, must be one of: Resources, SharedResources, ServerlessResources")
 	}
@@ -101,7 +116,19 @@ func (r *Database) ValidateCreate() error {
 func (r *Database) ValidateUpdate(old runtime.Object) error {
 	databaselog.Info("validate update", "name", r.Name)
 
-	// TODO(user): fill in your validation logic upon object update.
+	oldDatabase, _ := old.(*Database)
+	if r.Spec.Domain != oldDatabase.Spec.Domain {
+		return errors.New("database domain cannot be changed")
+	}
+
+	oldDatabasePath := oldDatabase.Spec.Path
+	if oldDatabase.Spec.Path == "" {
+		oldDatabasePath = GetDatabasePath(r)
+	}
+	if r.Spec.Path != oldDatabasePath {
+		return errors.New("database path cannot be changed")
+	}
+
 	return nil
 }
 

api/v1alpha1/storage_types.go

@@ -106,6 +106,16 @@ type StorageSpec struct {
 	// +optional
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
 
+	// (Optional) If specified, the pod's topologySpreadConstraints.
+	// All topologySpreadConstraints are ANDed.
+	// +optional
+	// +patchMergeKey=topologyKey
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=topologyKey
+	// +listMapKey=whenUnsatisfiable
+	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty" patchStrategy:"merge" patchMergeKey:"topologyKey"`
+
 	// (Optional) Additional custom resource labels that are added to all resources
 	// +optional
 	AdditionalLabels map[string]string `json:"additionalLabels,omitempty"`

api/v1alpha1/zz_generated.deepcopy.go

@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.4.23
+version: 0.4.24
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.4.23"
+appVersion: "0.4.24"