feat(system): path to upgrade standalone to BE [EE-4071] (#8095)

api/http/handler/handler.go

@@ -29,8 +29,8 @@ import (
 	"github.com/portainer/portainer/api/http/handler/settings"
 	"github.com/portainer/portainer/api/http/handler/ssl"
 	"github.com/portainer/portainer/api/http/handler/stacks"
-	"github.com/portainer/portainer/api/http/handler/status"
 	"github.com/portainer/portainer/api/http/handler/storybook"
+	"github.com/portainer/portainer/api/http/handler/system"
 	"github.com/portainer/portainer/api/http/handler/tags"
 	"github.com/portainer/portainer/api/http/handler/teammemberships"
 	"github.com/portainer/portainer/api/http/handler/teams"
@@ -69,8 +69,8 @@ type Handler struct {
 	OpenAMTHandler         *openamt.Handler
 	FDOHandler             *fdo.Handler
 	StackHandler           *stacks.Handler
-	StatusHandler          *status.Handler
 	StorybookHandler       *storybook.Handler
+	SystemHandler          *system.Handler
 	TagHandler             *tags.Handler
 	TeamMembershipHandler  *teammemberships.Handler
 	TeamHandler            *teams.Handler
@@ -133,8 +133,6 @@ type Handler struct {
 // @tag.description Manage roles
 // @tag.name settings
 // @tag.description Manage Portainer settings
-// @tag.name status
-// @tag.description Information about the Portainer instance
 // @tag.name users
 // @tag.description Manage users
 // @tag.name tags
@@ -155,6 +153,10 @@ type Handler struct {
 // @tag.description Manage webhooks
 // @tag.name websocket
 // @tag.description Create exec sessions using websockets
+// @tag.name status
+// @tag.description Information about the Portainer instance
+// @tag.name system
+// @tag.description Manage Portainer system
 
 // ServeHTTP delegates a request to the appropriate subhandler.
 func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
@@ -218,7 +220,9 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	case strings.HasPrefix(r.URL.Path, "/api/stacks"):
 		http.StripPrefix("/api", h.StackHandler).ServeHTTP(w, r)
 	case strings.HasPrefix(r.URL.Path, "/api/status"):
-		http.StripPrefix("/api", h.StatusHandler).ServeHTTP(w, r)
+		http.StripPrefix("/api", h.SystemHandler).ServeHTTP(w, r)
+	case strings.HasPrefix(r.URL.Path, "/api/system"):
+		http.StripPrefix("/api", h.SystemHandler).ServeHTTP(w, r)
 	case strings.HasPrefix(r.URL.Path, "/api/tags"):
 		http.StripPrefix("/api", h.TagHandler).ServeHTTP(w, r)
 	case strings.HasPrefix(r.URL.Path, "/api/templates/helm"):

api/http/handler/status/handler.go

@@ -1,41 +0,0 @@
-package status
-
-import (
-	"net/http"
-
-	"github.com/gorilla/mux"
-	httperror "github.com/portainer/libhttp/error"
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/demo"
-	"github.com/portainer/portainer/api/http/security"
-)
-
-// Handler is the HTTP handler used to handle status operations.
-type Handler struct {
-	*mux.Router
-	status      *portainer.Status
-	dataStore   dataservices.DataStore
-	demoService *demo.Service
-}
-
-// NewHandler creates a handler to manage status operations.
-func NewHandler(bouncer *security.RequestBouncer, status *portainer.Status, demoService *demo.Service, dataStore dataservices.DataStore) *Handler {
-	h := &Handler{
-		Router:      mux.NewRouter(),
-		dataStore:   dataStore,
-		demoService: demoService,
-		status:      status,
-	}
-
-	h.Handle("/status",
-		bouncer.PublicAccess(httperror.LoggerHandler(h.statusInspect))).Methods(http.MethodGet)
-	h.Handle("/status/version",
-		bouncer.AuthenticatedAccess(http.HandlerFunc(h.version))).Methods(http.MethodGet)
-	h.Handle("/status/nodes",
-		bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.statusNodesCount))).Methods(http.MethodGet)
-	h.Handle("/status/system",
-		bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.statusSystem))).Methods(http.MethodGet)
-
-	return h
-}

api/http/handler/status/status_inspect.go

@@ -1,30 +0,0 @@
-package status
-
-import (
-	"net/http"
-
-	httperror "github.com/portainer/libhttp/error"
-	"github.com/portainer/libhttp/response"
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/demo"
-)
-
-type status struct {
-	*portainer.Status
-	DemoEnvironment demo.EnvironmentDetails
-}
-
-// @id StatusInspect
-// @summary Check Portainer status
-// @description Retrieve Portainer status
-// @description **Access policy**: public
-// @tags status
-// @produce json
-// @success 200 {object} status "Success"
-// @router /status [get]
-func (handler *Handler) statusInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
-	return response.JSON(w, &status{
-		Status:          handler.status,
-		DemoEnvironment: handler.demoService.Details(),
-	})
-}

api/http/handler/system/handler.go

@@ -0,0 +1,67 @@
+package system
+
+import (
+	"net/http"
+
+	"github.com/gorilla/mux"
+	httperror "github.com/portainer/libhttp/error"
+	portainer "github.com/portainer/portainer/api"
+	"github.com/portainer/portainer/api/dataservices"
+	"github.com/portainer/portainer/api/demo"
+	"github.com/portainer/portainer/api/http/security"
+	"github.com/portainer/portainer/api/internal/upgrade"
+)
+
+// Handler is the HTTP handler used to handle status operations.
+type Handler struct {
+	*mux.Router
+	status         *portainer.Status
+	dataStore      dataservices.DataStore
+	demoService    *demo.Service
+	upgradeService upgrade.Service
+}
+
+// NewHandler creates a handler to manage status operations.
+func NewHandler(bouncer *security.RequestBouncer,
+	status *portainer.Status,
+	demoService *demo.Service,
+	dataStore dataservices.DataStore,
+	upgradeService upgrade.Service) *Handler {
+
+	h := &Handler{
+		Router:         mux.NewRouter(),
+		dataStore:      dataStore,
+		demoService:    demoService,
+		status:         status,
+		upgradeService: upgradeService,
+	}
+
+	router := h.PathPrefix("/system").Subrouter()
+
+	adminRouter := router.PathPrefix("/").Subrouter()
+	adminRouter.Use(bouncer.AdminAccess)
+
+	adminRouter.Handle("/upgrade", httperror.LoggerHandler(h.systemUpgrade)).Methods(http.MethodPost)
+
+	authenticatedRouter := router.PathPrefix("/").Subrouter()
+	authenticatedRouter.Use(bouncer.AuthenticatedAccess)
+
+	authenticatedRouter.Handle("/version", http.HandlerFunc(h.version)).Methods(http.MethodGet)
+	authenticatedRouter.Handle("/nodes", httperror.LoggerHandler(h.systemNodesCount)).Methods(http.MethodGet)
+	authenticatedRouter.Handle("/info", httperror.LoggerHandler(h.systemInfo)).Methods(http.MethodGet)
+
+	publicRouter := router.PathPrefix("/").Subrouter()
+	publicRouter.Use(bouncer.PublicAccess)
+
+	publicRouter.Handle("/status", httperror.LoggerHandler(h.systemStatus)).Methods(http.MethodGet)
+
+	// Deprecated /status endpoint, will be removed in the future.
+	h.Handle("/status",
+		bouncer.PublicAccess(httperror.LoggerHandler(h.statusInspectDeprecated))).Methods(http.MethodGet)
+	h.Handle("/status/version",
+		bouncer.AuthenticatedAccess(http.HandlerFunc(h.versionDeprecated))).Methods(http.MethodGet)
+	h.Handle("/status/nodes",
+		bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.statusNodesCountDeprecated))).Methods(http.MethodGet)
+
+	return h
+}

api/http/handler/system/nodes_count.go

@@ -1,4 +1,4 @@
-package status
+package system
 
 import (
 	"net/http"
@@ -7,23 +7,24 @@ import (
 	"github.com/portainer/libhttp/response"
 	statusutil "github.com/portainer/portainer/api/internal/nodes"
 	"github.com/portainer/portainer/api/internal/snapshot"
+	"github.com/rs/zerolog/log"
 )
 
 type nodesCountResponse struct {
 	Nodes int `json:"nodes"`
 }
 
-// @id statusNodesCount
+// @id systemNodesCount
 // @summary Retrieve the count of nodes
 // @description **Access policy**: authenticated
 // @security ApiKeyAuth
 // @security jwt
-// @tags status
+// @tags system
 // @produce json
 // @success 200 {object} nodesCountResponse "Success"
 // @failure 500 "Server error"
-// @router /status/nodes [get]
-func (handler *Handler) statusNodesCount(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+// @router /system/nodes [get]
+func (handler *Handler) systemNodesCount(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
 	endpoints, err := handler.dataStore.Endpoint().Endpoints()
 	if err != nil {
 		return httperror.InternalServerError("Failed to get environment list", err)
@@ -40,3 +41,21 @@ func (handler *Handler) statusNodesCount(w http.ResponseWriter, r *http.Request)
 
 	return response.JSON(w, &nodesCountResponse{Nodes: nodes})
 }
+
+// @id statusNodesCount
+// @summary Retrieve the count of nodes
+// @deprecated
+// @description Deprecated: use the `/system/nodes` endpoint instead.
+// @description **Access policy**: authenticated
+// @security ApiKeyAuth
+// @security jwt
+// @tags status
+// @produce json
+// @success 200 {object} nodesCountResponse "Success"
+// @failure 500 "Server error"
+// @router /status/nodes [get]
+func (handler *Handler) statusNodesCountDeprecated(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+	log.Warn().Msg("The /status/nodes endpoint is deprecated, please use the /system/nodes endpoint instead")
+
+	return handler.systemNodesCount(w, r)
+}

api/http/handler/system/status.go

@@ -0,0 +1,48 @@
+package system
+
+import (
+	"net/http"
+
+	httperror "github.com/portainer/libhttp/error"
+	"github.com/portainer/libhttp/response"
+	portainer "github.com/portainer/portainer/api"
+	"github.com/portainer/portainer/api/demo"
+	"github.com/rs/zerolog/log"
+)
+
+type status struct {
+	*portainer.Status
+	DemoEnvironment demo.EnvironmentDetails
+}
+
+// @id systemStatus
+// @summary Check Portainer status
+// @description Retrieve Portainer status
+// @description **Access policy**: public
+// @tags system
+// @produce json
+// @success 200 {object} status "Success"
+// @router /system/status [get]
+func (handler *Handler) systemStatus(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+	return response.JSON(w, &status{
+		Status:          handler.status,
+		DemoEnvironment: handler.demoService.Details(),
+	})
+}
+
+// swagger docs for deprecated route:
+// @id StatusInspect
+// @summary Check Portainer status
+// @deprecated
+// @description Deprecated: use the `/system/status` endpoint instead.
+// @description Retrieve Portainer status
+// @description **Access policy**: public
+// @tags status
+// @produce json
+// @success 200 {object} status "Success"
+// @router /status [get]
+func (handler *Handler) statusInspectDeprecated(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+	log.Warn().Msg("The /status endpoint is deprecated and will be removed in a future version of Portainer. Please use the /system/status endpoint instead.")
+
+	return handler.systemStatus(w, r)
+}

api/http/handler/system/system_info.go

@@ -1,4 +1,4 @@
-package status
+package system
 
 import (
 	"net/http"
@@ -7,6 +7,7 @@ import (
 	"github.com/portainer/libhttp/response"
 	"github.com/portainer/portainer/api/internal/endpointutils"
 	"github.com/portainer/portainer/api/platform"
+	plf "github.com/portainer/portainer/api/platform"
 )
 
 type systemInfoResponse struct {
@@ -16,17 +17,17 @@ type systemInfoResponse struct {
 	Agents      int                        `json:"agents"`
 }
 
-// @id statusSystem
+// @id systemInfo
 // @summary Retrieve system info
 // @description **Access policy**: authenticated
 // @security ApiKeyAuth
 // @security jwt
-// @tags status
+// @tags system
 // @produce json
 // @success 200 {object} systemInfoResponse "Success"
 // @failure 500 "Server error"
-// @router /status/system [get]
-func (handler *Handler) statusSystem(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+// @router /system/info [get]
+func (handler *Handler) systemInfo(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
 	environments, err := handler.dataStore.Endpoint().Endpoints()
 	if err != nil {
 		return httperror.InternalServerError("Failed to get environment list", err)
@@ -48,13 +49,17 @@ func (handler *Handler) statusSystem(w http.ResponseWriter, r *http.Request) *ht
 		if environment.IsEdgeDevice {
 			edgeDevices++
 		}
+	}
 
+	platform, err := plf.DetermineContainerPlatform()
+	if err != nil {
+		return httperror.InternalServerError("Unable to determine container platform", err)
 	}
 
 	return response.JSON(w, &systemInfoResponse{
 		EdgeAgents:  edgeAgents,
 		EdgeDevices: edgeDevices,
 		Agents:      agents,
-		Platform:    platform.DetermineContainerPlatform(),
+		Platform:    platform,
 	})
 }

api/http/handler/system/system_upgrade.go

@@ -0,0 +1,54 @@
+package system
+
+import (
+	"net/http"
+	"regexp"
+
+	"github.com/pkg/errors"
+	httperror "github.com/portainer/libhttp/error"
+	"github.com/portainer/libhttp/request"
+	"github.com/portainer/libhttp/response"
+	"github.com/rs/zerolog/log"
+)
+
+type systemUpgradePayload struct {
+	License string
+}
+
+var re = regexp.MustCompile(`^\d-.+`)
+
+func (payload *systemUpgradePayload) Validate(r *http.Request) error {
+	if payload.License == "" {
+		return errors.New("license is missing")
+	}
+
+	if !re.MatchString(payload.License) {
+		return errors.New("license is invalid")
+	}
+
+	return nil
+}
+
+// @id systemUpgrade
+// @summary Upgrade Portainer to BE
+// @description Upgrade Portainer to BE
+// @description **Access policy**: administrator
+// @tags system
+// @produce json
+// @success 200 {object} status "Success"
+// @router /system/upgrade [post]
+func (handler *Handler) systemUpgrade(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
+	payload, err := request.GetPayload[systemUpgradePayload](r)
+	if err != nil {
+		return httperror.BadRequest("Invalid request payload", err)
+	}
+
+	go func() {
+		err = handler.upgradeService.Upgrade(payload.License)
+		if err != nil {
+			log.Error().Err(err).Msg("Failed to upgrade Portainer")
+		}
+	}()
+
+	return response.Empty(w)
+}

api/http/handler/system/version.go

@@ -1,4 +1,4 @@
-package status
+package system
 
 import (
 	"encoding/json"
@@ -33,16 +33,16 @@ type BuildInfo struct {
 	GoVersion      string
 }
 
-// @id Version
+// @id systemVersion
 // @summary Check for portainer updates
 // @description Check if portainer has an update available
 // @description **Access policy**: authenticated
 // @security ApiKeyAuth
 // @security jwt
-// @tags status
+// @tags system
 // @produce json
 // @success 200 {object} versionResponse "Success"
-// @router /status/version [get]
+// @router /system/version [get]
 func (handler *Handler) version(w http.ResponseWriter, r *http.Request) {
 
 	result := &versionResponse{
@@ -106,3 +106,21 @@ func HasNewerVersion(currentVersion, latestVersion string) bool {
 
 	return currentVersionSemver.LessThan(*latestVersionSemver)
 }
+
+// @id Version
+// @summary Check for portainer updates
+// @deprecated
+// @description Deprecated: use the `/system/version` endpoint instead.
+// @description Check if portainer has an update available
+// @description **Access policy**: authenticated
+// @security ApiKeyAuth
+// @security jwt
+// @tags status
+// @produce json
+// @success 200 {object} versionResponse "Success"
+// @router /status/version [get]
+func (handler *Handler) versionDeprecated(w http.ResponseWriter, r *http.Request) {
+	log.Warn().Msg("The /status/version endpoint is deprecated, please use the /system/version endpoint instead")
+
+	handler.version(w, r)
+}

api/http/server.go

@@ -40,8 +40,8 @@ import (
 	"github.com/portainer/portainer/api/http/handler/settings"
 	sslhandler "github.com/portainer/portainer/api/http/handler/ssl"
 	"github.com/portainer/portainer/api/http/handler/stacks"
-	"github.com/portainer/portainer/api/http/handler/status"
 	"github.com/portainer/portainer/api/http/handler/storybook"
+	"github.com/portainer/portainer/api/http/handler/system"
 	"github.com/portainer/portainer/api/http/handler/tags"
 	"github.com/portainer/portainer/api/http/handler/teammemberships"
 	"github.com/portainer/portainer/api/http/handler/teams"
@@ -57,6 +57,7 @@ import (
 	"github.com/portainer/portainer/api/internal/authorization"
 	edgestackservice "github.com/portainer/portainer/api/internal/edge/edgestacks"
 	"github.com/portainer/portainer/api/internal/ssl"
+	"github.com/portainer/portainer/api/internal/upgrade"
 	k8s "github.com/portainer/portainer/api/kubernetes"
 	"github.com/portainer/portainer/api/kubernetes/cli"
 	"github.com/portainer/portainer/api/scheduler"
@@ -103,6 +104,7 @@ type Server struct {
 	ShutdownTrigger             context.CancelFunc
 	StackDeployer               deployments.StackDeployer
 	DemoService                 *demo.Service
+	UpgradeService              upgrade.Service
 }
 
 // Start starts the HTTP server
@@ -251,7 +253,11 @@ func (server *Server) Start() error {
 	var teamMembershipHandler = teammemberships.NewHandler(requestBouncer)
 	teamMembershipHandler.DataStore = server.DataStore
 
-	var statusHandler = status.NewHandler(requestBouncer, server.Status, server.DemoService, server.DataStore)
+	var systemHandler = system.NewHandler(requestBouncer,
+		server.Status,
+		server.DemoService,
+		server.DataStore,
+		server.UpgradeService)
 
 	var templatesHandler = templates.NewHandler(requestBouncer)
 	templatesHandler.DataStore = server.DataStore
@@ -301,9 +307,9 @@ func (server *Server) Start() error {
 		ResourceControlHandler: resourceControlHandler,
 		SettingsHandler:        settingsHandler,
 		SSLHandler:             sslHandler,
-		StatusHandler:          statusHandler,
 		StackHandler:           stackHandler,
 		StorybookHandler:       storybookHandler,
+		SystemHandler:          systemHandler,
 		TagHandler:             tagHandler,
 		TeamHandler:            teamHandler,
 		TeamMembershipHandler:  teamMembershipHandler,