refactor: maintain rename to admin (polarismesh#1063)

Author: chuntaojun

maintain/api.go admin/api.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"context"
@@ -47,8 +47,8 @@ type ConnStatsResp struct {
 	Stats           []*connlimit.HostConnStat
 }
 
-// MaintainOperateServer Maintain related operation
-type MaintainOperateServer interface {
+// AdminOperateServer Maintain related operation
+type AdminOperateServer interface {
 	// GetServerConnections Get connection count
 	GetServerConnections(ctx context.Context, req *ConnReq) (*ConnCountResp, error)
 	// GetServerConnStats 获取连接缓存里面的统计信息

maintain/config.go admin/config.go

@@ -15,9 +15,9 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
-import "github.com/polarismesh/polaris/maintain/job"
+import "github.com/polarismesh/polaris/admin/job"
 
 // Config maintain configuration
 type Config struct {

maintain/default.go admin/default.go

@@ -15,22 +15,22 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"context"
 	"errors"
 
+	"github.com/polarismesh/polaris/admin/job"
 	"github.com/polarismesh/polaris/auth"
 	"github.com/polarismesh/polaris/cache"
-	"github.com/polarismesh/polaris/maintain/job"
 	"github.com/polarismesh/polaris/service"
 	"github.com/polarismesh/polaris/service/healthcheck"
 	"github.com/polarismesh/polaris/store"
 )
 
 var (
-	server         MaintainOperateServer
+	server         AdminOperateServer
 	maintainServer = &Server{}
 	finishInit     bool
 )
@@ -75,9 +75,9 @@ func initialize(_ context.Context, cfg *Config, namingService service.DiscoverSe
 }
 
 // GetServer 获取已经初始化好的Server
-func GetServer() (MaintainOperateServer, error) {
+func GetServer() (AdminOperateServer, error) {
 	if !finishInit {
-		return nil, errors.New("MaintainOperateServer has not done Initialize")
+		return nil, errors.New("AdminOperateServer has not done Initialize")
 	}
 
 	return server, nil
@@ -86,7 +86,7 @@ func GetServer() (MaintainOperateServer, error) {
 // GetOriginServer 获取已经初始化好的Server
 func GetOriginServer() (*Server, error) {
 	if !finishInit {
-		return nil, errors.New("MaintainOperateServer has not done Initialize")
+		return nil, errors.New("AdminOperateServer has not done Initialize")
 	}
 
 	return maintainServer, nil

maintain/job/clean_deleted_instance.go admin/job/clean_deleted_instance.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	commonlog "github.com/polarismesh/polaris/common/log"

maintain/job/config.go admin/job/config.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"context"

maintain/job/delete_empty_service.go admin/job/delete_empty_service.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"context"
@@ -27,7 +27,7 @@ import (
 	"github.com/polarismesh/polaris/common/utils"
 )
 
-var _ MaintainOperateServer = (*serverAuthAbility)(nil)
+var _ AdminOperateServer = (*serverAuthAbility)(nil)
 
 func (svr *serverAuthAbility) GetServerConnections(ctx context.Context, req *ConnReq) (*ConnCountResp, error) {
 	authCtx := svr.collectMaintainAuthContext(ctx, model.Read, "GetServerConnections")

maintain/job/delete_empty_service_test.go admin/job/delete_empty_service_test.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"sync"
@@ -26,7 +26,7 @@ import (
 	"github.com/polarismesh/polaris/store"
 )
 
-var _ MaintainOperateServer = (*Server)(nil)
+var _ AdminOperateServer = (*Server)(nil)
 
 type Server struct {
 	mu                sync.Mutex

maintain/job/delete_unhealthy_instance.go admin/job/delete_unhealthy_instance.go

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package maintain
+package admin
 
 import (
 	"context"
@@ -34,7 +34,7 @@ type serverAuthAbility struct {
 	authMgn      auth.AuthChecker
 }
 
-func newServerAuthAbility(targetServer *Server, authSvr auth.AuthServer) MaintainOperateServer {
+func newServerAuthAbility(targetServer *Server, authSvr auth.AuthServer) AdminOperateServer {
 	proxy := &serverAuthAbility{
 		targetServer: targetServer,
 		authSvr:      authSvr,

maintain/job/delete_unhealthy_instance_test.go admin/job/delete_unhealthy_instance_test.go

@@ -21,8 +21,8 @@ import (
 	"github.com/emicklei/go-restful/v3"
 )
 
-// GetAdminServer get admin server
-func (h *HTTPServer) GetAdminServer() *restful.WebService {
+// GetIndexServer get index server
+func (h *HTTPServer) GetIndexServer() *restful.WebService {
 	ws := new(restful.WebService)
 
 	ws.Route(ws.GET("/").To(h.index))

maintain/job/job.go admin/job/job.go

@@ -27,15 +27,15 @@ import (
 	apimodel "github.com/polarismesh/specification/source/go/api/v1/model"
 	apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
 
+	"github.com/polarismesh/polaris/admin"
 	httpcommon "github.com/polarismesh/polaris/apiserver/httpserver/http"
 	api "github.com/polarismesh/polaris/common/api/v1"
 	"github.com/polarismesh/polaris/common/model"
 	"github.com/polarismesh/polaris/common/utils"
-	"github.com/polarismesh/polaris/maintain"
 )
 
 // GetMaintainAccessServer 运维接口
-func (h *HTTPServer) GetMaintainAccessServer() *restful.WebService {
+func (h *HTTPServer) GetAdminAccessServer() *restful.WebService {
 	ws := new(restful.WebService)
 	ws.Path("/maintain/v1").Consumes(restful.MIME_JSON).Produces(restful.MIME_JSON)
 
@@ -62,7 +62,7 @@ func (h *HTTPServer) GetMaintainAccessServer() *restful.WebService {
 func (h *HTTPServer) GetServerConnections(req *restful.Request, rsp *restful.Response) {
 	ctx := initContext(req)
 	params := httpcommon.ParseQueryParams(req)
-	connReq := maintain.ConnReq{
+	connReq := admin.ConnReq{
 		Protocol: params["protocol"],
 		Host:     params["host"],
 	}
@@ -87,7 +87,7 @@ func (h *HTTPServer) GetServerConnStats(req *restful.Request, rsp *restful.Respo
 		}
 	}
 
-	connReq := maintain.ConnReq{
+	connReq := admin.ConnReq{
 		Protocol: params["protocol"],
 		Host:     params["host"],
 		Amount:   amount,
@@ -105,7 +105,7 @@ func (h *HTTPServer) GetServerConnStats(req *restful.Request, rsp *restful.Respo
 func (h *HTTPServer) CloseConnections(req *restful.Request, rsp *restful.Response) {
 	log.Info("[MAINTAIN] Start doing close connections")
 	ctx := initContext(req)
-	var connReqs []maintain.ConnReq
+	var connReqs []admin.ConnReq
 	decoder := json.NewDecoder(req.Request.Body)
 	if err := decoder.Decode(&connReqs); err != nil {
 		log.Errorf("[MAINTAIN] close connection decode body err: %s", err.Error())

maintain/log.go admin/log.go

@@ -22,7 +22,7 @@ import (
 	restfulspec "github.com/polarismesh/go-restful-openapi/v2"
 	apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
 
-	"github.com/polarismesh/polaris/maintain"
+	"github.com/polarismesh/polaris/admin"
 )
 
 var (
@@ -52,7 +52,7 @@ func enrichCloseConnectionsApiDocs(r *restful.RouteBuilder) *restful.RouteBuilde
 	return r.
 		Doc("关闭指定client ip的连接").
 		Metadata(restfulspec.KeyOpenAPITags, maintainApiTags).
-		Reads([]maintain.ConnReq{}).
+		Reads([]admin.ConnReq{}).
 		Notes(enrichCloseConnectionsApiNotes)
 }
 

maintain/maintain.go admin/maintain.go

@@ -30,6 +30,7 @@ import (
 	"github.com/pkg/errors"
 	"go.uber.org/zap"
 
+	"github.com/polarismesh/polaris/admin"
 	"github.com/polarismesh/polaris/apiserver"
 	httpcommon "github.com/polarismesh/polaris/apiserver/httpserver/http"
 	v1 "github.com/polarismesh/polaris/apiserver/httpserver/v1"
@@ -42,7 +43,6 @@ import (
 	"github.com/polarismesh/polaris/common/secure"
 	"github.com/polarismesh/polaris/common/utils"
 	"github.com/polarismesh/polaris/config"
-	"github.com/polarismesh/polaris/maintain"
 	"github.com/polarismesh/polaris/namespace"
 	"github.com/polarismesh/polaris/plugin"
 	"github.com/polarismesh/polaris/service"
@@ -65,7 +65,7 @@ type HTTPServer struct {
 	enableSwagger bool
 
 	server            *http.Server
-	maintainServer    maintain.MaintainOperateServer
+	maintainServer    admin.AdminOperateServer
 	namespaceServer   namespace.NamespaceOperateServer
 	namingServer      service.DiscoverServer
 	configServer      config.ConfigCenterServer
@@ -151,7 +151,7 @@ func (h *HTTPServer) Run(errCh chan error) {
 
 	var err error
 
-	h.maintainServer, err = maintain.GetServer()
+	h.maintainServer, err = admin.GetServer()
 	if err != nil {
 		log.Errorf("%v", err)
 		errCh <- err
@@ -327,8 +327,8 @@ func (h *HTTPServer) createRestfulContainer() (*restful.Container, error) {
 		switch name {
 		case "admin":
 			if apiConfig.Enable {
-				wsContainer.Add(h.GetAdminServer())
-				wsContainer.Add(h.GetMaintainAccessServer())
+				wsContainer.Add(h.GetIndexServer())
+				wsContainer.Add(h.GetAdminAccessServer())
 			}
 		case "console":
 			if apiConfig.Enable {

maintain/maintain_authability.go admin/maintain_authability.go

@@ -25,12 +25,12 @@ import (
 
 	"gopkg.in/yaml.v2"
 
+	"github.com/polarismesh/polaris/admin"
 	"github.com/polarismesh/polaris/apiserver"
 	"github.com/polarismesh/polaris/auth"
 	"github.com/polarismesh/polaris/cache"
 	"github.com/polarismesh/polaris/common/log"
 	"github.com/polarismesh/polaris/config"
-	"github.com/polarismesh/polaris/maintain"
 	"github.com/polarismesh/polaris/namespace"
 	"github.com/polarismesh/polaris/plugin"
 	"github.com/polarismesh/polaris/service"
@@ -47,7 +47,7 @@ type Config struct {
 	Naming       service.Config     `yaml:"naming"`
 	Config       config.Config      `yaml:"config"`
 	HealthChecks healthcheck.Config `yaml:"healthcheck"`
-	Maintain     maintain.Config    `yaml:"maintain"`
+	Maintain     admin.Config       `yaml:"maintain"`
 	Store        store.Config       `yaml:"store"`
 	Auth         auth.Config        `yaml:"auth"`
 	Plugin       plugin.Config      `yaml:"plugin"`

maintain/server.go admin/server.go

@@ -30,6 +30,7 @@ import (
 	"go.uber.org/zap"
 	"gopkg.in/yaml.v2"
 
+	"github.com/polarismesh/polaris/admin"
 	"github.com/polarismesh/polaris/apiserver"
 	"github.com/polarismesh/polaris/auth"
 	boot_config "github.com/polarismesh/polaris/bootstrap/config"
@@ -42,7 +43,6 @@ import (
 	"github.com/polarismesh/polaris/common/utils"
 	"github.com/polarismesh/polaris/common/version"
 	config_center "github.com/polarismesh/polaris/config"
-	"github.com/polarismesh/polaris/maintain"
 	"github.com/polarismesh/polaris/namespace"
 	"github.com/polarismesh/polaris/plugin"
 	"github.com/polarismesh/polaris/service"
@@ -197,7 +197,7 @@ func StartComponents(ctx context.Context, cfg *boot_config.Config) error {
 	}
 
 	// 初始化运维操作模块
-	if err := maintain.Initialize(ctx, &cfg.Maintain, namingSvr, healthCheckServer, cacheMgn, s); err != nil {
+	if err := admin.Initialize(ctx, &cfg.Maintain, namingSvr, healthCheckServer, cacheMgn, s); err != nil {
 		return err
 	}
 

maintain/server_authability.go admin/server_authability.go

@@ -28,7 +28,7 @@ const (
 	ElectionKeyMaintainJobPrefix  = "MaintainJob."
 )
 
-type MaintainStore interface {
+type AdminStore interface {
 	// StartLeaderElection start leader election
 	StartLeaderElection(key string) error
 

apiserver/httpserver/admin.go

@@ -52,8 +52,8 @@ type Store interface {
 	// ClientStore Client the central module storage interface
 	ClientStore
 
-	// MaintainStore Maintain inteface
-	MaintainStore
+	// AdminStore Maintain inteface
+	AdminStore
 }
 
 // NamespaceStore Namespace storage interface