Merge branch 'main' into support/refine-cluster-component-v1-api

apecloud · Sep 14, 2024 · 7a6100b · 7a6100b
2 parents 47eabd6 + b6416ec
commit 7a6100b
Show file tree

Hide file tree

Showing 31 changed files with 339 additions and 458 deletions.
diff --git a/apis/apps/v1/cluster_types.go b/apis/apps/v1/cluster_types.go
@@ -548,75 +548,6 @@ type ClusterComponentService struct {
 	PodService *bool `json:"podService,omitempty"`
 }
 
-// UserResourceRefs defines references to user-defined Secrets and ConfigMaps.
-type UserResourceRefs struct {
-	// SecretRefs defines the user-defined Secrets.
-	//
-	// +patchMergeKey=name
-	// +patchStrategy=merge,retainKeys
-	// +listType=map
-	// +listMapKey=name
-	// +optional
-	SecretRefs []SecretRef `json:"secretRefs,omitempty"`
-
-	// ConfigMapRefs defines the user-defined ConfigMaps.
-	//
-	// +patchMergeKey=name
-	// +patchStrategy=merge,retainKeys
-	// +listType=map
-	// +listMapKey=name
-	// +optional
-	ConfigMapRefs []ConfigMapRef `json:"configMapRefs,omitempty"`
-}
-
-// SecretRef defines a reference to a Secret.
-type SecretRef struct {
-	ResourceMeta `json:",inline"`
-
-	// Secret specifies the Secret to be mounted as a volume.
-	//
-	// +kubebuilder:validation:Required
-	Secret corev1.SecretVolumeSource `json:"secret"`
-}
-
-// ConfigMapRef defines a reference to a ConfigMap.
-type ConfigMapRef struct {
-	ResourceMeta `json:",inline"`
-
-	// ConfigMap specifies the ConfigMap to be mounted as a volume.
-	//
-	// +kubebuilder:validation:Required
-	ConfigMap corev1.ConfigMapVolumeSource `json:"configMap"`
-}
-
-// ResourceMeta encapsulates metadata and configuration for referencing ConfigMaps and Secrets as volumes.
-type ResourceMeta struct {
-	// Name is the name of the referenced ConfigMap or Secret object. It must conform to DNS label standards.
-	//
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MaxLength=63
-	// +kubebuilder:validation:Pattern:=`^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$`
-	Name string `json:"name"`
-
-	// MountPoint is the filesystem path where the volume will be mounted.
-	//
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MaxLength=256
-	// +kubebuilder:validation:Pattern:=`^/[a-z]([a-z0-9\-]*[a-z0-9])?$`
-	MountPoint string `json:"mountPoint"`
-
-	// SubPath specifies a path within the volume from which to mount.
-	//
-	// +optional
-	SubPath string `json:"subPath,omitempty"`
-
-	// AsVolumeFrom lists the names of containers in which the volume should be mounted.
-	//
-	// +listType=set
-	// +optional
-	AsVolumeFrom []string `json:"asVolumeFrom,omitempty"`
-}
-
 // ShardingSpec defines how KubeBlocks manage dynamic provisioned shards.
 // A typical design pattern for distributed databases is to distribute data across multiple shards,
 // with each shard consisting of multiple replicas.

diff --git a/apis/apps/v1/component_types.go b/apis/apps/v1/component_types.go
@@ -150,7 +150,6 @@ type ComponentSpec struct {
 	Volumes []corev1.Volume `json:"volumes,omitempty"`
 
 	// Overrides Services defined in referenced ComponentDefinition.
-	// by clients.
 	//
 	// +optional
 	Services []ComponentService `json:"services,omitempty"`

diff --git a/apis/apps/v1/componentdefinition_types.go b/apis/apps/v1/componentdefinition_types.go
@@ -997,9 +997,9 @@ type ComponentTemplateSpec struct {
 	// template will be mounted to the corresponding volume. Must be a DNS_LABEL name.
 	// The volume name must be defined in podSpec.containers[*].volumeMounts.
 	//
-	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MaxLength=63
 	// +kubebuilder:validation:Pattern:=`^[a-z]([a-z0-9\-]*[a-z0-9])?$`
+	// +optional
 	VolumeName string `json:"volumeName"`
 
 	// The operator attempts to set default file permissions for scripts (0555) and configurations (0444).
@@ -1104,6 +1104,11 @@ type ComponentConfigSpec struct {
 	// +listType=set
 	// +optional
 	ReRenderResourceTypes []RerenderResourceType `json:"reRenderResourceTypes,omitempty"`
+
+	// Whether to store the final rendered parameters as a secret.
+	//
+	// +optional
+	AsSecret *bool `json:"asSecret,omitempty"`
 }
 
 // LegacyRenderedTemplateSpec describes the configuration extension for the lazy rendered template.

diff --git a/apis/apps/v1/zz_generated.deepcopy.go b/apis/apps/v1/zz_generated.deepcopy.go
diff --git a/apis/apps/v1alpha1/config_meta.go b/apis/apps/v1alpha1/config_meta.go
@@ -84,6 +84,10 @@ func (configSpec *ComponentConfigSpec) InjectEnvEnabled() bool {
 	return len(configSpec.AsEnvFrom) > 0 || len(configSpec.InjectEnvTo) > 0
 }
 
+func (configSpec *ComponentConfigSpec) ToSecret() bool {
+	return configSpec.AsSecret != nil && *configSpec.AsSecret
+}
+
 func (configSpec *ComponentConfigSpec) ContainersInjectedTo() []string {
 	if len(configSpec.InjectEnvTo) != 0 {
 		return configSpec.InjectEnvTo

diff --git a/apis/apps/v1alpha1/type.go b/apis/apps/v1alpha1/type.go
@@ -65,9 +65,9 @@ type ComponentTemplateSpec struct {
 	// template will be mounted to the corresponding volume. Must be a DNS_LABEL name.
 	// The volume name must be defined in podSpec.containers[*].volumeMounts.
 	//
-	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MaxLength=63
 	// +kubebuilder:validation:Pattern:=`^[a-z]([a-z0-9\-]*[a-z0-9])?$`
+	// +optional
 	VolumeName string `json:"volumeName"`
 
 	// The operator attempts to set default file permissions for scripts (0555) and configurations (0444).
@@ -201,6 +201,11 @@ type ComponentConfigSpec struct {
 	// +listType=set
 	// +optional
 	ReRenderResourceTypes []RerenderResourceType `json:"reRenderResourceTypes,omitempty"`
+
+	// Whether to store the final rendered parameters as a secret.
+	//
+	// +optional
+	AsSecret *bool `json:"asSecret,omitempty"`
 }
 
 // RerenderResourceType defines the resource requirements for a component.

diff --git a/apis/apps/v1alpha1/zz_generated.deepcopy.go b/apis/apps/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/apps.kubeblocks.io_clusterdefinitions.yaml b/config/crd/bases/apps.kubeblocks.io_clusterdefinitions.yaml
@@ -401,6 +401,10 @@ spec:
                               type: string
                             type: array
                             x-kubernetes-list-type: set
+                          asSecret:
+                            description: Whether to store the final rendered parameters
+                              as a secret.
+                            type: boolean
                           constraintRef:
                             description: Specifies the name of the referenced configuration
                               constraints object.
@@ -552,7 +556,6 @@ spec:
                             type: string
                         required:
                         - name
-                        - volumeName
                         type: object
                       type: array
                       x-kubernetes-list-map-keys:
@@ -9112,7 +9115,6 @@ spec:
                             type: string
                         required:
                         - name
-                        - volumeName
                         type: object
                       type: array
                       x-kubernetes-list-map-keys:

diff --git a/config/crd/bases/apps.kubeblocks.io_componentdefinitions.yaml b/config/crd/bases/apps.kubeblocks.io_componentdefinitions.yaml
@@ -138,6 +138,10 @@ spec:
                         type: string
                       type: array
                       x-kubernetes-list-type: set
+                    asSecret:
+                      description: Whether to store the final rendered parameters
+                        as a secret.
+                      type: boolean
                     constraintRef:
                       description: Specifies the name of the referenced configuration
                         constraints object.
@@ -289,7 +293,6 @@ spec:
                       type: string
                   required:
                   - name
-                  - volumeName
                   type: object
                 type: array
                 x-kubernetes-list-map-keys:
@@ -11638,7 +11641,6 @@ spec:
                       type: string
                   required:
                   - name
-                  - volumeName
                   type: object
                 type: array
                 x-kubernetes-list-map-keys:
@@ -13260,6 +13262,10 @@ spec:
                         type: string
                       type: array
                       x-kubernetes-list-type: set
+                    asSecret:
+                      description: Whether to store the final rendered parameters
+                        as a secret.
+                      type: boolean
                     constraintRef:
                       description: Specifies the name of the referenced configuration
                         constraints object.
@@ -13411,7 +13417,6 @@ spec:
                       type: string
                   required:
                   - name
-                  - volumeName
                   type: object
                 type: array
                 x-kubernetes-list-map-keys:
@@ -26667,7 +26672,6 @@ spec:
                       type: string
                   required:
                   - name
-                  - volumeName
                   type: object
                 type: array
                 x-kubernetes-list-map-keys:

diff --git a/config/crd/bases/apps.kubeblocks.io_components.yaml b/config/crd/bases/apps.kubeblocks.io_components.yaml
@@ -4974,9 +4974,7 @@ spec:
                 maxLength: 32
                 type: string
               services:
-                description: |-
-                  Overrides Services defined in referenced ComponentDefinition.
-                  by clients.
+                description: Overrides Services defined in referenced ComponentDefinition.
                 items:
                   description: |-
                     ComponentService defines a service that would be exposed as an inter-component service within a Cluster.

diff --git a/config/crd/bases/apps.kubeblocks.io_configurations.yaml b/config/crd/bases/apps.kubeblocks.io_configurations.yaml
@@ -135,6 +135,10 @@ spec:
                             type: string
                           type: array
                           x-kubernetes-list-type: set
+                        asSecret:
+                          description: Whether to store the final rendered parameters
+                            as a secret.
+                          type: boolean
                         constraintRef:
                           description: Specifies the name of the referenced configuration
                             constraints object.
@@ -286,7 +290,6 @@ spec:
                           type: string
                       required:
                       - name
-                      - volumeName
                       type: object
                     importTemplateRef:
                       description: |-