feat: add scheduler features api for manager (#3488)

Signed-off-by: Gaius <gaius.qi@gmail.com>

Author: gaius-qi

api/manager/docs.go

@@ -2292,6 +2292,41 @@ const docTemplate = `{
                 }
             }
         },
+        "/scheduler-features": {
+            "get": {
+                "description": "Get Scheduler Features",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Scheduler Feature"
+                ],
+                "summary": "Get Scheudler Features",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "500": {
+                        "description": "Internal Server Error"
+                    }
+                }
+            }
+        },
         "/schedulers": {
             "get": {
                 "description": "Get Schedulers",

api/manager/swagger.json

@@ -2286,6 +2286,41 @@
                 }
             }
         },
+        "/scheduler-features": {
+            "get": {
+                "description": "Get Scheduler Features",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Scheduler Feature"
+                ],
+                "summary": "Get Scheudler Features",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "500": {
+                        "description": "Internal Server Error"
+                    }
+                }
+            }
+        },
         "/schedulers": {
             "get": {
                 "description": "Get Schedulers",

api/manager/swagger.yaml

@@ -2582,6 +2582,29 @@ paths:
       summary: Add Scheduler to schedulerCluster
       tags:
       - SchedulerCluster
+  /scheduler-features:
+    get:
+      consumes:
+      - application/json
+      description: Get Scheduler Features
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              type: string
+            type: array
+        "400":
+          description: Bad Request
+        "404":
+          description: Not Found
+        "500":
+          description: Internal Server Error
+      summary: Get Scheudler Features
+      tags:
+      - Scheduler Feature
   /schedulers:
     get:
       consumes:

manager/handlers/scheduler_feature.go

@@ -0,0 +1,41 @@
+/*
+ *     Copyright 2024 The Dragonfly Authors
+ *
+ * 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 handlers
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+
+	// nolint
+	_ "d7y.io/dragonfly/v2/manager/models"
+)
+
+// @Summary Get Scheudler Features
+// @Description Get Scheduler Features
+// @Tags Scheduler Feature
+// @Accept json
+// @Produce json
+// @Success 200 {array} string
+// @Failure 400
+// @Failure 404
+// @Failure 500
+// @Router /scheduler-features [get]
+func (h *Handlers) GetSchedulerFeatures(ctx *gin.Context) {
+	features := h.service.GetSchedulerFeatures(ctx.Request.Context())
+	ctx.JSON(http.StatusOK, features)
+}

manager/router/router.go

@@ -159,6 +159,10 @@ func Init(cfg *config.Config, logDir string, service service.Service, database *
 	s.GET(":id", h.GetScheduler)
 	s.GET("", h.GetSchedulers)
 
+	// Scheduler Feature.
+	sf := apiv1.Group("/scheduler-features", jwt.MiddlewareFunc(), rbac)
+	sf.GET("", h.GetSchedulerFeatures)
+
 	// Seed Peer Cluster.
 	spc := apiv1.Group("/seed-peer-clusters", jwt.MiddlewareFunc(), rbac)
 	spc.POST("", h.CreateSeedPeerCluster)

manager/service/mocks/service_mock.go

@@ -0,0 +1,27 @@
+/*
+ *     Copyright 2024 The Dragonfly Authors
+ *
+ * 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 service
+
+import (
+	"context"
+
+	"d7y.io/dragonfly/v2/manager/types"
+)
+
+func (s *service) GetSchedulerFeatures(ctx context.Context) []string {
+	return types.DefaultSchedulerFeatures
+}

manager/service/scheduler_feature.go

@@ -101,6 +101,7 @@ type Service interface {
 	UpdateScheduler(context.Context, uint, types.UpdateSchedulerRequest) (*models.Scheduler, error)
 	GetScheduler(context.Context, uint) (*models.Scheduler, error)
 	GetSchedulers(context.Context, types.GetSchedulersQuery) ([]models.Scheduler, int64, error)
+	GetSchedulerFeatures(context.Context) []string
 
 	CreateBucket(context.Context, types.CreateBucketRequest) error
 	DestroyBucket(context.Context, string) error

manager/service/service.go

@@ -16,19 +16,6 @@
 
 package types
 
-const (
-	// SchedulerFeatureSchedule is the schedule feature of scheduler.
-	SchedulerFeatureSchedule = "schedule"
-
-	// SchedulerFeaturePreheat is the preheat feature of scheduler.
-	SchedulerFeaturePreheat = "preheat"
-)
-
-var (
-	// DefaultSchedulerFeatures is the default features of scheduler.
-	DefaultSchedulerFeatures = []string{SchedulerFeatureSchedule, SchedulerFeaturePreheat}
-)
-
 type SchedulerParams struct {
 	ID uint `uri:"id" binding:"required"`
 }

manager/types/scheduler.go

@@ -0,0 +1,30 @@
+/*
+ *     Copyright 2024 The Dragonfly Authors
+ *
+ * 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 types
+
+const (
+	// SchedulerFeatureSchedule is the schedule feature of scheduler.
+	SchedulerFeatureSchedule = "schedule"
+
+	// SchedulerFeaturePreheat is the preheat feature of scheduler.
+	SchedulerFeaturePreheat = "preheat"
+)
+
+var (
+	// DefaultSchedulerFeatures is the default features of scheduler.
+	DefaultSchedulerFeatures = []string{SchedulerFeatureSchedule, SchedulerFeaturePreheat}
+)