Seamless K8s Cluster Provisioning Support

assets/k8sclusterinfo.yaml

@@ -0,0 +1,80 @@
+# Configuration for Cluster(Kubernetes) of Cloud Service Providers (CSPs)
+# This file is used to define the feature of clusters
+
+# The file is in YAML format and contains the following fields:
+# k8scluster: Top level key
+#   <csp>: Name of the CSP
+#     nodegroupsWithCluster:
+#     version:
+#       - region: [region1, region2, all(special keyword)]
+
+k8scluster:
+  nhncloud:
+    nodegroupsWithCluster: true
+    version:
+      - region: [kr1, kr2]
+        available:
+          - name: 1.28
+            id: 1.28.9-aliyun.1
+          - name: 1.26
+            id: 1.26.15-aliyun.1
+          - name: 1.24
+            id: 1.24.6-aliyun.1
+      - region: [jp1]
+    nodeImage:
+      - region: [kr1]
+        available:
+          - name: default
+            id: default
+          - name: aliyun 3.9
+            id: aliyun_3_9_x64_20G_alibase_20231219.vhd
+      - region: [kr2]
+        available:
+          - name: default
+            id: default
+          - name: aliyun 3.9
+            id: aliyun_3_9_x64_20G_alibase_20231219.vhd
+      - region: [jp1]
+    rootDisk:
+      - region: [all]
+        type:
+          - name: default
+            id: default
+          - name: basic
+            id: CLOUD_BASIC
+        size:
+          min: 10
+          max: 40
+  alibaba:
+    nodegroupsWithCluster: true
+    version:
+      - region: [all]
+        available:
+          - name: 1.28
+            id: 1.28.9-aliyun.1
+          - name: 1.26
+            id: 1.26.15-aliyun.1
+          - name: 1.24
+            id: 1.24.6-aliyun.1
+    nodeImage:
+      - region: [eu-west-1]
+        #configurable: true
+        available:
+          - name: default
+            id: default
+          - name: aliyun 3.9
+            id: aliyun_3_9_x64_20G_alibase_20231219.vhd
+      - region: [eu-west-2,kr2]
+    rootDisk:
+      - region: [eu-west-1]
+        type:
+          #configurable: true
+          - name: default
+            id: default
+          - name: basic
+            id: CLOUD_BASIC
+        size:
+          #configurable: true
+          min: 10
+          max: 40
+

src/api/rest/docs/docs.go

@@ -8079,6 +8079,54 @@ const docTemplate = `{
                 }
             }
         },
+        "/recommendK8sClusterSpec": {
+            "post": {
+                "description": "Recommend K8s Cluster plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Infra service] Cluster Provisioning Management"
+                ],
+                "summary": "Recommend K8s Cluster plan (filter and priority)",
+                "parameters": [
+                    {
+                        "description": "Recommend K8s Cluster plan (filter and priority)",
+                        "name": "deploymentPlan",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.DeploymentPlan"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/mcir.TbSpecInfo"
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/region": {
             "get": {
                 "description": "List all registered regions",

src/api/rest/docs/swagger.json

@@ -8072,6 +8072,54 @@
                 }
             }
         },
+        "/recommendK8sClusterSpec": {
+            "post": {
+                "description": "Recommend K8s Cluster plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Infra service] Cluster Provisioning Management"
+                ],
+                "summary": "Recommend K8s Cluster plan (filter and priority)",
+                "parameters": [
+                    {
+                        "description": "Recommend K8s Cluster plan (filter and priority)",
+                        "name": "deploymentPlan",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.DeploymentPlan"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/mcir.TbSpecInfo"
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/region": {
             "get": {
                 "description": "List all registered regions",

src/api/rest/docs/swagger.yaml

@@ -8408,6 +8408,38 @@ paths:
       summary: Check Tumblebug is ready
       tags:
       - '[Admin] System management'
+  /recommendK8sClusterSpec:
+    post:
+      consumes:
+      - application/json
+      description: Recommend K8s Cluster plan (filter and priority) Find details from
+        https://github.com/cloud-barista/cb-tumblebug/discussions/1234
+      parameters:
+      - description: Recommend K8s Cluster plan (filter and priority)
+        in: body
+        name: deploymentPlan
+        schema:
+          $ref: '#/definitions/mcis.DeploymentPlan'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/mcir.TbSpecInfo'
+            type: array
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+      summary: Recommend K8s Cluster plan (filter and priority)
+      tags:
+      - '[Infra service] Cluster Provisioning Management'
   /region:
     get:
       consumes:

src/api/rest/server/mcis/recommendation.go

@@ -49,6 +49,33 @@ func RestRecommendVm(c echo.Context) error {
 	return common.EndRequestWithLog(c, reqID, err, content)
 }
 
+// RestRecommendK8sClusterSpec godoc
+// @Summary Recommend K8s Cluster plan (filter and priority)
+// @Description Recommend K8s Cluster plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234
+// @Tags [Infra service] Cluster Provisioning Management
+// @Accept json
+// @Produce json
+// @Param deploymentPlan body mcis.DeploymentPlan false "Recommend K8s Cluster plan (filter and priority)"
+// @Success 200 {object} []mcir.TbSpecInfo
+// @Failure 404 {object} common.SimpleMsg
+// @Failure 500 {object} common.SimpleMsg
+// @Router /recommendK8sClusterSpec [post]
+func RestRecommendK8sClusterSpec(c echo.Context) error {
+	reqID, idErr := common.StartRequestWithLog(c)
+	if idErr != nil {
+		return c.JSON(http.StatusBadRequest, map[string]string{"message": idErr.Error()})
+	}
+	nsId := common.SystemCommonNs
+
+	u := &mcis.DeploymentPlan{}
+	if err := c.Bind(u); err != nil {
+		return common.EndRequestWithLog(c, reqID, err, nil)
+	}
+
+	content, err := mcis.RecommendK8sClusterSpec(nsId, *u)
+	return common.EndRequestWithLog(c, reqID, err, content)
+}
+
 type RestPostMcisRecommendResponse struct {
 	//VmReq          []TbVmRecommendReq    `json:"vmReq"`
 	VmRecommend    []mcis.TbVmRecommendInfo `json:"vmRecommend"`

src/api/rest/server/server.go

@@ -235,6 +235,9 @@ func RunServer(port string) {
 	g.POST("/:nsId/mcisDynamic", rest_mcis.RestPostMcisDynamic)
 	g.POST("/:nsId/mcis/:mcisId/vmDynamic", rest_mcis.RestPostMcisVmDynamic)
 
+	// @Tags [Infra] Cluster Provisioning Management
+	e.POST("/tumblebug/recommendK8sClusterSpec", rest_mcis.RestRecommendK8sClusterSpec)
+
 	//g.GET("/:nsId/mcis/:mcisId", rest_mcis.RestGetMcis, middleware.TimeoutWithConfig(middleware.TimeoutConfig{Timeout: 20 * time.Second}), middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(1)))
 	//g.GET("/:nsId/mcis", rest_mcis.RestGetAllMcis, middleware.TimeoutWithConfig(middleware.TimeoutConfig{Timeout: 20 * time.Second}), middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(1)))
 	// path specific timeout and ratelimit

src/core/common/config.go

@@ -65,6 +65,65 @@ type Credential struct {
 
 var RuntimeCredential = Credential{}
 
+// K8sClusterInfo is structure for kubernetes cluster information
+type K8sClusterInfo struct {
+	CSPs map[string]K8sClusterDetail `mapstructure:"k8scluster" json:"k8s_cluster"`
+}
+
+// K8sClusterDetail is structure for kubernetes cluster detail information
+type K8sClusterDetail struct {
+	NodeGroupsWithCluster bool              `mapstructure:"nodegroupsWithCluster" json:"nodegroups_with_cluster"`
+	Version               []VersionDetail   `mapstructure:"version" json:"versions"`
+	NodeImage             []NodeImageDetail `mapstructure:"nodeImage" json:"node_images"`
+	RootDisk              []RootDiskDetail  `mapstructure:"rootDisk" json:"root_disks"`
+}
+
+// VersionDetail is structure for kubernetes cluster version detail information
+type VersionDetail struct {
+	Region    []string                 `mapstructure:"region" json:"region"`
+	Available []VersionDetailAvailable `mapstructure:"available" json:"availables"`
+}
+
+// VersionDetailAvailable is structure for kubernetes cluster version detail's available information
+type VersionDetailAvailable struct {
+	Name string `mapstructure:"name" json:"name"`
+	Id   string `mapstructure:"id" json:"id"`
+}
+
+// NodeImageDetail is structure for kubernetes cluster node image detail information
+type NodeImageDetail struct {
+	Region    []string                   `mapstructure:"region" json:"region"`
+	Available []NodeImageDetailAvailable `mapstructure:"available" json:"availables"`
+}
+
+// NodeImageDetailAvailable is structure for kubernetes cluster node image detail's available information
+type NodeImageDetailAvailable struct {
+	Name string `mapstructure:"name" json:"name"`
+	Id   string `mapstructure:"id" json:"id"`
+}
+
+// RootDiskDetail is structure for kubernetes cluster root disk detail information
+type RootDiskDetail struct {
+	Region []string             `mapstructure:"region" json:"region"`
+	Type   []RootDiskDetailType `mapstructure:"type" json:"type"`
+	Size   RootDiskDetailSize   `mapstructure:"size" json:"size"`
+}
+
+// RootDiskDetailType is structure for kubernetes cluster root disk detail's type information
+type RootDiskDetailType struct {
+	Name string `mapstructure:"name" json:"name"`
+	Id   string `mapstructure:"id" json:"id"`
+}
+
+// RootDiskDetailSize is structure for kubernetes cluster root disk detail's size information
+type RootDiskDetailSize struct {
+	Min uint `mapstructure:"min" json:"min"`
+	Max uint `mapstructure:"max" json:"max"`
+}
+
+// RuntimeK8sClusterInfo is global variable for K8sClusterInfo
+var RuntimeK8sClusterInfo = K8sClusterInfo{}
+
 // AdjustKeysToLowercase adjusts the keys of nested maps to lowercase.
 func AdjustKeysToLowercase(cloudInfo *CloudInfo) {
 	newCSPs := make(map[string]CSPDetail)

src/core/mcir/spec.go

@@ -155,6 +155,11 @@ type FilterSpecsByRangeRequest struct {
 	EvaluationScore10   Range  `json:"evaluationScore10"`
 }
 
+type FilterK8sClusterByRangeRequest struct {
+	FilterSpecsByRangeRequest
+	Version string `json:"version"`
+}
+
 // ConvertSpiderSpecToTumblebugSpec accepts an Spider spec object, converts to and returns an TB spec object
 func ConvertSpiderSpecToTumblebugSpec(spiderSpec SpiderSpecInfo) (TbSpecInfo, error) {
 	if spiderSpec.Name == "" {