Support updating system controller (#1144)

* Support updating system controller * Fix integration failure
easegress-io · Dec 5, 2023 · 918d1bb · 918d1bb
1 parent f894a76
commit 918d1bb
Show file tree

Hide file tree

Showing 26 changed files with 226 additions and 101 deletions.
diff --git a/build/test/integration_test.go b/build/test/integration_test.go
@@ -317,7 +317,7 @@ func TestEgctlCmd(t *testing.T) {
 		output, stderr, err := runCmd(cmd)
 		assert.NoError(err)
 		assert.Empty(stderr)
-		head := []string{"NAME", "ALIASES", "KIND", "ACTION"}
+		head := []string{"NAME", "ALIASES", "CATEGORY", "KIND", "ACTION"}
 		assert.True(matchTable(head, output))
 		assert.True(matchTable([]string{"member", "m,mem,members", "Member", "delete,get,describe"}, output))
 		assert.Contains(output, "create,apply,delete,get,describe")
@@ -628,7 +628,7 @@ func TestLogs(t *testing.T) {
 		// check if new logs are printed
 		yamlStr := `
 kind: HTTPServer
-name: test-egctl-logs        
+name: test-egctl-logs
 port: 12345
 rules:
 - paths:

diff --git a/cmd/client/commandv2/general.go b/cmd/client/commandv2/general.go
@@ -134,13 +134,13 @@ func APIResourcesCmd() *cobra.Command {
 				sort.Slice(r.Aliases, func(i, j int) bool {
 					return len(r.Aliases[i]) < len(r.Aliases[j])
 				})
-				tables = append(tables, []string{r.Name, strings.Join(r.Aliases, ","), r.Kind, action})
+				tables = append(tables, []string{r.Name, strings.Join(r.Aliases, ","), r.Category, r.Kind, action})
 			}
 			sort.Slice(tables, func(i, j int) bool {
 				return tables[i][0] < tables[j][0]
 			})
 
-			tables = append([][]string{{"NAME", "ALIASES", "KIND", "ACTION"}}, tables...)
+			tables = append([][]string{{"NAME", "ALIASES", "CATEGORY", "KIND", "ACTION"}}, tables...)
 			tables = append(tables, []string{cdk.Name, strings.Join(cdk.Aliases, ","), cdk.Kind, action})
 			tables = append(tables, []string{cd.Name, strings.Join(cd.Aliases, ","), cd.Kind, action})
 			tables = append(tables, []string{member.Name, strings.Join(member.Aliases, ","), member.Kind, "delete,get,describe"})

diff --git a/pkg/api/object.go b/pkg/api/object.go
@@ -138,6 +138,10 @@ func (s *Server) createObject(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	if spec.Categroy() == supervisor.CategorySystemController {
+		HandleAPIError(w, r, http.StatusConflict, fmt.Errorf("can't create system controller object"))
+	}
+
 	name := spec.Name()
 
 	s.Lock()
@@ -164,6 +168,12 @@ func (s *Server) deleteObject(w http.ResponseWriter, r *http.Request) {
 	defer s.Unlock()
 
 	spec := s._getObject(name)
+
+	if spec.Categroy() == supervisor.CategorySystemController {
+		HandleAPIError(w, r, http.StatusBadRequest, fmt.Errorf("can't delete system controller object"))
+		return
+	}
+
 	if spec == nil {
 		HandleAPIError(w, r, http.StatusNotFound, fmt.Errorf("not found"))
 		return

diff --git a/pkg/api/registry.go b/pkg/api/registry.go
@@ -23,13 +23,14 @@ import (
 )
 
 type APIResource struct {
-	Kind    string
-	Name    string
-	Aliases []string
+	Category string
+	Kind     string
+	Name     string
+	Aliases  []string
 }
 
 // key is Kind name, now only contains api resource of object.
-var objectApiResource = map[string]*APIResource{}
+var objectAPIResource = map[string]*APIResource{}
 
 func RegisterObject(r *APIResource) {
 	if r.Kind == "" {
@@ -39,16 +40,16 @@ func RegisterObject(r *APIResource) {
 		panic(fmt.Errorf("%v: empty name", r))
 	}
 
-	existedObject, existed := objectApiResource[r.Kind]
+	existedObject, existed := objectAPIResource[r.Kind]
 	if existed {
 		panic(fmt.Errorf("%v and %v got same kind: %s", r, existedObject, r.Kind))
 	}
-	objectApiResource[r.Kind] = r
+	objectAPIResource[r.Kind] = r
 }
 
 func ObjectAPIResources() []*APIResource {
 	resources := []*APIResource{}
-	for _, r := range objectApiResource {
+	for _, r := range objectAPIResource {
 		resources = append(resources, r)
 	}
 	return resources

diff --git a/pkg/object/autocertmanager/autocertmanager.go b/pkg/object/autocertmanager/autocertmanager.go
@@ -55,9 +55,10 @@ var aliases = []string{
 func init() {
 	supervisor.Register(&AutoCertManager{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/consulserviceregistry/consulserviceregistry.go b/pkg/object/consulserviceregistry/consulserviceregistry.go
@@ -50,9 +50,10 @@ var aliases = []string{"consul", "consulserviceregistrys"}
 func init() {
 	supervisor.Register(&ConsulServiceRegistry{})
 	egapi.RegisterObject(&egapi.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/easemonitormetrics/easemonitormetrics.go b/pkg/object/easemonitormetrics/easemonitormetrics.go
@@ -37,6 +37,9 @@ import (
 )
 
 const (
+	// Category is the category of EaseMonitorMetrics.
+	Category = supervisor.CategoryBusinessController
+
 	// Kind is EaseMonitorMetrics kind.
 	Kind = "EaseMonitorMetrics"
 )
@@ -54,9 +57,10 @@ func init() {
 	}
 
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/etcdserviceregistry/etcdserviceregistry.go b/pkg/object/etcdserviceregistry/etcdserviceregistry.go
@@ -50,9 +50,10 @@ var aliases = []string{"etcd"}
 func init() {
 	supervisor.Register(&EtcdServiceRegistry{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/eurekaserviceregistry/eurekaserviceregistry.go b/pkg/object/eurekaserviceregistry/eurekaserviceregistry.go
@@ -49,9 +49,10 @@ var aliases = []string{"eureka"}
 func init() {
 	supervisor.Register(&EurekaServiceRegistry{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    name,
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     name,
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/function/faascontroller.go b/pkg/object/function/faascontroller.go
@@ -44,9 +44,10 @@ var aliases = []string{
 func init() {
 	supervisor.Register(&FaasController{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/globalfilter/globalfilter.go b/pkg/object/globalfilter/globalfilter.go
@@ -43,9 +43,10 @@ var aliases = []string{"globalfilters"}
 func init() {
 	supervisor.Register(&GlobalFilter{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: aliases,
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  aliases,
 	})
 }
 

diff --git a/pkg/object/grpcserver/grpcserver.go b/pkg/object/grpcserver/grpcserver.go
@@ -37,9 +37,10 @@ const (
 func init() {
 	supervisor.Register(&GRPCServer{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"grpc"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"grpc"},
 	})
 }
 

diff --git a/pkg/object/httpserver/httpserver.go b/pkg/object/httpserver/httpserver.go
@@ -37,9 +37,10 @@ const (
 func init() {
 	supervisor.Register(&HTTPServer{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"httpservers", "hs"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"httpservers", "hs"},
 	})
 }
 

diff --git a/pkg/object/ingresscontroller/ingresscontroller.go b/pkg/object/ingresscontroller/ingresscontroller.go
@@ -45,9 +45,10 @@ const (
 func init() {
 	supervisor.Register(&IngressController{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"ingresscontrollers", "ingress"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"ingresscontrollers", "ingress"},
 	})
 }
 

diff --git a/pkg/object/meshcontroller/meshcontroller.go b/pkg/object/meshcontroller/meshcontroller.go
@@ -43,9 +43,10 @@ const (
 func init() {
 	supervisor.Register(&MeshController{})
 	egapi.RegisterObject(&egapi.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"mesh", "meshcontrollers"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"mesh", "meshcontrollers"},
 	})
 }
 

diff --git a/pkg/object/mqttproxy/mqttproxy.go b/pkg/object/mqttproxy/mqttproxy.go
@@ -45,9 +45,10 @@ var _ supervisor.TrafficObject = (*MQTTProxy)(nil)
 func init() {
 	supervisor.Register(&MQTTProxy{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"mqtt", "mp"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"mqtt", "mp"},
 	})
 }
 

diff --git a/pkg/object/nacosserviceregistry/nacosserviceregistry.go b/pkg/object/nacosserviceregistry/nacosserviceregistry.go
@@ -55,9 +55,10 @@ const (
 func init() {
 	supervisor.Register(&NacosServiceRegistry{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"nacos"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"nacos"},
 	})
 }
 

diff --git a/pkg/object/pipeline/pipeline.go b/pkg/object/pipeline/pipeline.go
@@ -47,9 +47,10 @@ const (
 func init() {
 	supervisor.Register(&Pipeline{})
 	api.RegisterObject(&api.APIResource{
-		Kind:    Kind,
-		Name:    strings.ToLower(Kind),
-		Aliases: []string{"pipelines", "pl"},
+		Category: Category,
+		Kind:     Kind,
+		Name:     strings.ToLower(Kind),
+		Aliases:  []string{"pipelines", "pl"},
 	})
 }