Add support for reconfigure Elasticsearch (#793)

* Add support for reconfigure Elasticsearch Signed-off-by: kamolhasan <[email protected]> * Change applyConfig to map Signed-off-by: kamolhasan <[email protected]> * Remove deprecation message Signed-off-by: kamolhasan <[email protected]>
kubedb · Oct 26, 2021 · 73f09b6 · 73f09b6
1 parent 997836d
commit 73f09b6
Show file tree

Hide file tree

Showing 11 changed files with 796 additions and 277 deletions.
diff --git a/apis/catalog/v1alpha1/elasticsearch_version_types.go b/apis/catalog/v1alpha1/elasticsearch_version_types.go
@@ -56,7 +56,6 @@ type ElasticsearchVersionSpec struct {
 	// Distribution
 	Distribution ElasticsearchDistro `json:"distribution,omitempty" protobuf:"bytes,2,opt,name=distribution,casttype=ElasticsearchDistro"`
 	// Authentication plugin used by Elasticsearch cluster
-	// Deprecated
 	AuthPlugin ElasticsearchAuthPlugin `json:"authPlugin" protobuf:"bytes,3,opt,name=authPlugin,casttype=ElasticsearchAuthPlugin"`
 	// Database Image
 	DB ElasticsearchVersionDatabase `json:"db" protobuf:"bytes,4,opt,name=db"`

diff --git a/apis/catalog/v1alpha1/generated.proto b/apis/catalog/v1alpha1/generated.proto
diff --git a/apis/catalog/v1alpha1/openapi_generated.go b/apis/catalog/v1alpha1/openapi_generated.go
diff --git a/apis/ops/v1alpha1/elasticsearch_ops_types.go b/apis/ops/v1alpha1/elasticsearch_ops_types.go
@@ -155,7 +155,37 @@ type ElasticsearchVolumeExpansionTopologySpec struct {
 	Coordinating *resource.Quantity `json:"coordinating,omitempty" protobuf:"bytes,11,opt,name=coordinating"`
 }
 
+// ElasticsearchCustomConfigurationSpec is the spec for Reconfiguring the Elasticsearch Settings
 type ElasticsearchCustomConfigurationSpec struct {
+	// ConfigSecret is an optional field to provide custom configuration file for database.
+	// +optional
+	ConfigSecret *core.LocalObjectReference `json:"configSecret,omitempty" protobuf:"bytes,1,opt,name=configSecret"`
+	// SecureConfigSecret is an optional field to provide secure settings for database.
+	//	- Ref: https://www.elastic.co/guide/en/elasticsearch/reference/7.14/secure-settings.html
+	// +optional
+	SecureConfigSecret *core.LocalObjectReference `json:"secureConfigSecret,omitempty" protobuf:"bytes,2,opt,name=secureConfigSecret"`
+	// ApplyConfig is an optional field to provide Elasticsearch configuration.
+	// Provided configuration will be applied to config files stored in ConfigSecret.
+	// If the ConfigSecret is missing, the operator will create a new k8s secret by the
+	// following naming convention: {db-name}-user-config .
+	// Expected input format:
+	//	applyConfig:
+	//		file-name.yml: |
+	//			key: value
+	//		elasticsearch.yml: |
+	//			thread_pool:
+	//				write:
+	//					size: 30
+	// +optional
+	ApplyConfig map[string]string `json:"applyConfig,omitempty" protobuf:"bytes,3,rep,name=applyConfig"`
+	// If set to "true", the user provided configuration will be removed.
+	// The Elasticsearch cluster will start will default configuration that is generated by the operator.
+	// +optional
+	RemoveCustomConfig bool `json:"removeCustomConfig,omitempty" protobuf:"varint,4,opt,name=removeCustomConfig"`
+	// If set to "true", the user provided secure settings will be removed.
+	// The elasticsearch.keystore will start will default password (i.e. "").
+	// +optional
+	RemoveSecureCustomConfig bool `json:"removeSecureCustomConfig,omitempty" protobuf:"varint,5,opt,name=removeSecureCustomConfig"`
 }
 
 type ElasticsearchCustomConfiguration struct {

diff --git a/apis/ops/v1alpha1/generated.pb.go b/apis/ops/v1alpha1/generated.pb.go
diff --git a/apis/ops/v1alpha1/generated.proto b/apis/ops/v1alpha1/generated.proto
diff --git a/apis/ops/v1alpha1/openapi_generated.go b/apis/ops/v1alpha1/openapi_generated.go
diff --git a/apis/ops/v1alpha1/type.go b/apis/ops/v1alpha1/type.go
@@ -125,6 +125,9 @@ const (
 	UpdateDataNodeResources            = "UpdateDataNodeResources"
 	UpdateIngestNodeResources          = "UpdateIngestNodeResources"
 	UpdateCombinedNodeResources        = "UpdateCombinedNodeResources"
+	PrepareCustomConfig                = "PrepareCustomConfig"
+	PrepareSecureCustomConfig          = "PrepareSecureCustomConfig"
+	ReconfigureSecurityAdmin           = "ReconfigureSecurityAdmin"
 
 	//Redis Constants
 	PatchedSecret  = "patchedSecret"

diff --git a/apis/ops/v1alpha1/zz_generated.deepcopy.go b/apis/ops/v1alpha1/zz_generated.deepcopy.go
diff --git a/crds/ops.kubedb.com_elasticsearchopsrequests.yaml b/crds/ops.kubedb.com_elasticsearchopsrequests.yaml
@@ -43,6 +43,25 @@ spec:
           spec:
             properties:
               configuration:
+                properties:
+                  applyConfig:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  configSecret:
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                  removeCustomConfig:
+                    type: boolean
+                  removeSecureCustomConfig:
+                    type: boolean
+                  secureConfigSecret:
+                    properties:
+                      name:
+                        type: string
+                    type: object
                 type: object
               databaseRef:
                 properties:

diff --git a/openapi/swagger.json b/openapi/swagger.json
@@ -27820,7 +27820,7 @@
       ],
       "properties": {
         "authPlugin": {
-          "description": "Authentication plugin used by Elasticsearch cluster Deprecated",
+          "description": "Authentication plugin used by Elasticsearch cluster",
           "type": "string",
           "default": ""
         },
@@ -31784,7 +31784,34 @@
       }
     },
     "dev.kubedb.apimachinery.apis.ops.v1alpha1.ElasticsearchCustomConfigurationSpec": {
-      "type": "object"
+      "description": "ElasticsearchCustomConfigurationSpec is the spec for Reconfiguring the Elasticsearch Settings",
+      "type": "object",
+      "properties": {
+        "applyConfig": {
+          "description": "ApplyConfig is an optional field to provide Elasticsearch configuration. Provided configuration will be applied to config files stored in ConfigSecret. If the ConfigSecret is missing, the operator will create a new k8s secret by the following naming convention: {db-name}-user-config . Expected input format:\n\tapplyConfig:\n\t\tfile-name.yml: |\n\t\t\tkey: value\n\t\telasticsearch.yml: |\n\t\t\tthread_pool:\n\t\t\t\twrite:\n\t\t\t\t\tsize: 30",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string",
+            "default": ""
+          }
+        },
+        "configSecret": {
+          "description": "ConfigSecret is an optional field to provide custom configuration file for database.",
+          "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
+        },
+        "removeCustomConfig": {
+          "description": "If set to \"true\", the user provided configuration will be removed. The Elasticsearch cluster will start will default configuration that is generated by the operator.",
+          "type": "boolean"
+        },
+        "removeSecureCustomConfig": {
+          "description": "If set to \"true\", the user provided secure settings will be removed. The elasticsearch.keystore will start will default password (i.e. \"\").",
+          "type": "boolean"
+        },
+        "secureConfigSecret": {
+          "description": "SecureConfigSecret is an optional field to provide secure settings for database.\n\t- Ref: https://www.elastic.co/guide/en/elasticsearch/reference/7.14/secure-settings.html",
+          "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
+        }
+      }
     },
     "dev.kubedb.apimachinery.apis.ops.v1alpha1.ElasticsearchHorizontalScalingSpec": {
       "description": "ElasticsearchHorizontalScalingSpec contains the horizontal scaling information of an Elasticsearch cluster",