PMM-11423: support for updating a service

api/inventorypb/json/inventorypb.json

@@ -11533,7 +11533,7 @@
     },
     "/v1/inventory/Services/Change": {
       "post": {
-        "description": "Changes service configuration.",
+        "description": "Changes service configuration. If a new cluster label is specified, it removes all backup/restore tasks scheduled for the related services. Fails if there are running backup/restore tasks.",
         "tags": [
           "Services"
         ],

api/inventorypb/services.proto

@@ -624,7 +624,7 @@ service Services {
     };
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       summary: "Change service"
-      description: "Changes service configuration."
+      description: "Changes service configuration. If a new cluster label is specified, it removes all backup/restore tasks scheduled for the related services. Fails if there are running backup/restore tasks."
     };
   }
 }

api/swagger/swagger-dev.json

@@ -15542,7 +15542,7 @@
     },
     "/v1/inventory/Services/Change": {
       "post": {
-        "description": "Changes service configuration.",
+        "description": "Changes service configuration. If a new cluster label is specified, it removes all backup/restore tasks scheduled for the related services. Fails if there are running backup/restore tasks.",
         "tags": [
           "Services"
         ],

api/swagger/swagger.json

@@ -12830,7 +12830,7 @@
     },
     "/v1/inventory/Services/Change": {
       "post": {
-        "description": "Changes service configuration.",
+        "description": "Changes service configuration. If a new cluster label is specified, it removes all backup/restore tasks scheduled for the related services. Fails if there are running backup/restore tasks.",
         "tags": [
           "Services"
         ],

managed/cmd/pmm-managed/main.go

@@ -83,6 +83,7 @@ import (
 	"github.com/percona/pmm/managed/services/management"
 	"github.com/percona/pmm/managed/services/management/alerting"
 	managementbackup "github.com/percona/pmm/managed/services/management/backup"
+	"github.com/percona/pmm/managed/services/management/common"
 	managementdbaas "github.com/percona/pmm/managed/services/management/dbaas"
 	managementgrpc "github.com/percona/pmm/managed/services/management/grpc"
 	"github.com/percona/pmm/managed/services/management/ia"
@@ -256,8 +257,13 @@ func runGRPCServer(ctx context.Context, deps *gRPCServerDeps, features gRPCServe
 		deps.db, deps.agentsRegistry, deps.agentsStateUpdater,
 		deps.vmdb, deps.connectionCheck, deps.agentService)
 
+	mgmtBackupsService := managementbackup.NewBackupsService(deps.db, deps.backupService, deps.compatibilityService, deps.schedulerService)
+	mgmtArtifactsService := managementbackup.NewArtifactsService(deps.db, deps.backupRemovalService, deps.pitrTimerangeService)
+	mgmtRestoreHistoryService := managementbackup.NewRestoreHistoryService(deps.db)
+	mgmtServices := common.MgmtServices{BackupsService: mgmtBackupsService, ArtifactsService: mgmtArtifactsService, RestoreHistoryService: mgmtRestoreHistoryService}
+
 	inventorypb.RegisterNodesServer(gRPCServer, inventorygrpc.NewNodesServer(nodesSvc))
-	inventorypb.RegisterServicesServer(gRPCServer, inventorygrpc.NewServicesServer(servicesSvc))
+	inventorypb.RegisterServicesServer(gRPCServer, inventorygrpc.NewServicesServer(servicesSvc, mgmtServices))
 	inventorypb.RegisterAgentsServer(gRPCServer, inventorygrpc.NewAgentsServer(agentsSvc))
 
 	nodeSvc := management.NewNodeService(deps.db, deps.grafanaClient)
@@ -289,10 +295,10 @@ func runGRPCServer(ctx context.Context, deps *gRPCServerDeps, features gRPCServe
 	iav1beta1.RegisterAlertsServer(gRPCServer, deps.alertsService)
 	alertingpb.RegisterAlertingServer(gRPCServer, deps.templatesService)
 
-	backuppb.RegisterBackupsServer(gRPCServer, managementbackup.NewBackupsService(deps.db, deps.backupService, deps.compatibilityService, deps.schedulerService))
+	backuppb.RegisterBackupsServer(gRPCServer, mgmtBackupsService)
 	backuppb.RegisterLocationsServer(gRPCServer, managementbackup.NewLocationsService(deps.db, deps.minioClient))
-	backuppb.RegisterArtifactsServer(gRPCServer, managementbackup.NewArtifactsService(deps.db, deps.backupRemovalService, deps.pitrTimerangeService))
-	backuppb.RegisterRestoreHistoryServer(gRPCServer, managementbackup.NewRestoreHistoryService(deps.db))
+	backuppb.RegisterArtifactsServer(gRPCServer, mgmtArtifactsService)
+	backuppb.RegisterRestoreHistoryServer(gRPCServer, mgmtRestoreHistoryService)
 
 	k8sServer := managementdbaas.NewKubernetesServer(deps.db, deps.dbaasClient, deps.kubernetesClient, deps.versionServiceClient, deps.grafanaClient)
 	deps.dbaasInitializer.RegisterKubernetesServer(k8sServer)

managed/cmd/pmm-managed/main_test.go

@@ -41,6 +41,7 @@ func TestPackages(t *testing.T) {
 func TestImports(t *testing.T) {
 	type constraint struct {
 		blacklistPrefixes []string
+		whitelistPrefixes []string
 	}
 
 	constraints := make(map[string]constraint)
@@ -76,7 +77,6 @@ func TestImports(t *testing.T) {
 		// those services should be independent too, but has some common code
 		// as converters, errors, ...
 		"github.com/percona/pmm/managed/services/grafana",
-		"github.com/percona/pmm/managed/services/inventory",
 		"github.com/percona/pmm/managed/services/management",
 		"github.com/percona/pmm/managed/services/server",
 		"github.com/percona/pmm/managed/services/checks",
@@ -89,6 +89,20 @@ func TestImports(t *testing.T) {
 		}
 	}
 
+	for _, service := range []string{
+		// TODO come up with a new code structure that allows cross-service communication without the need to do tricks.
+		"github.com/percona/pmm/managed/services/inventory",
+	} {
+		constraints[service] = constraint{
+			blacklistPrefixes: []string{
+				"github.com/percona/pmm/managed/services/",
+			},
+			whitelistPrefixes: []string{
+				"github.com/percona/pmm/managed/services/management/common",
+			},
+		}
+	}
+
 	// validators should not import gRPC stack, including errors
 	constraints["github.com/percona/pmm/managed/utils/validators"] = constraint{
 		blacklistPrefixes: []string{
@@ -127,6 +141,18 @@ func TestImports(t *testing.T) {
 						continue
 					}
 
+					// check allowlist
+					var allow bool
+					for _, a := range c.whitelistPrefixes {
+						if strings.HasPrefix(i, a) {
+							allow = true
+							break
+						}
+					}
+					if allow {
+						continue
+					}
+
 					// check blacklist
 					if strings.HasPrefix(i, b) {
 						t.Errorf("Package %q should not import package %q (blacklisted by %q).", path, i, b)

managed/services/inventory/grpc/services_server.go

@@ -20,21 +20,29 @@ import (
 	"fmt"
 
 	"github.com/AlekSi/pointer"
+	"github.com/pkg/errors"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 
 	"github.com/percona/pmm/api/inventorypb"
 	"github.com/percona/pmm/managed/models"
 	"github.com/percona/pmm/managed/services/inventory"
+	"github.com/percona/pmm/managed/services/management/common"
 )
 
 type servicesServer struct {
-	s *inventory.ServicesService
+	s            *inventory.ServicesService
+	mgmtServices common.MgmtServices
 
 	inventorypb.UnimplementedServicesServer
 }
 
 // NewServicesServer returns Inventory API handler for managing Services.
-func NewServicesServer(s *inventory.ServicesService) inventorypb.ServicesServer {
-	return &servicesServer{s: s}
+func NewServicesServer(s *inventory.ServicesService, mgmtServices common.MgmtServices) inventorypb.ServicesServer {
+	return &servicesServer{
+		s:            s,
+		mgmtServices: mgmtServices,
+	}
 }
 
 var serviceTypes = map[inventorypb.ServiceType]models.ServiceType{
@@ -281,11 +289,26 @@ func (s *servicesServer) RemoveCustomLabels(ctx context.Context, req *inventoryp
 
 // ChangeService changes service configuration.
 func (s *servicesServer) ChangeService(ctx context.Context, req *inventorypb.ChangeServiceRequest) (*inventorypb.ChangeServiceResponse, error) {
-	return s.s.ChangeService(ctx, &models.ChangeStandardLabelsParams{
+	err := s.s.ChangeService(ctx, s.mgmtServices, &models.ChangeStandardLabelsParams{
 		ServiceID:      req.ServiceId,
 		Cluster:        req.Cluster,
 		Environment:    req.Environment,
 		ReplicationSet: req.ReplicationSet,
 		ExternalGroup:  req.ExternalGroup,
 	})
+	if err != nil {
+		return nil, toAPIError(err)
+	}
+
+	return &inventorypb.ChangeServiceResponse{}, nil
+}
+
+// toAPIError converts GO errors into API-level errors.
+func toAPIError(err error) error {
+	switch {
+	case errors.Is(err, common.ErrClusterLocked):
+		return status.Error(codes.FailedPrecondition, err.Error())
+	default:
+		return err
+	}
 }

managed/services/inventory/services.go

@@ -24,6 +24,7 @@ import (
 	"github.com/percona/pmm/api/inventorypb"
 	"github.com/percona/pmm/managed/models"
 	"github.com/percona/pmm/managed/services"
+	"github.com/percona/pmm/managed/services/management/common"
 )
 
 // ServicesService works with inventory API Services.
@@ -434,7 +435,11 @@ func (ss *ServicesService) RemoveCustomLabels(ctx context.Context, req *inventor
 }
 
 // ChangeService changes service configuration.
-func (ss *ServicesService) ChangeService(ctx context.Context, params *models.ChangeStandardLabelsParams) (*inventorypb.ChangeServiceResponse, error) {
+func (ss *ServicesService) ChangeService(ctx context.Context, mgmtServices common.MgmtServices, params *models.ChangeStandardLabelsParams) error {
+	if err := mgmtServices.RemoveScheduledTasks(ctx, ss.db, params); err != nil {
+		return err
+	}
+
 	errTx := ss.db.InTransactionContext(ctx, nil, func(tx *reform.TX) error {
 		err := models.ChangeStandardLabels(tx.Querier, params.ServiceID, models.ServiceStandardLabelsParams{
 			Cluster:        params.Cluster,
@@ -445,14 +450,14 @@ func (ss *ServicesService) ChangeService(ctx context.Context, params *models.Cha
 		return err
 	})
 	if errTx != nil {
-		return nil, errTx
+		return errTx
 	}
 
 	if err := ss.updateScrapeConfig(ctx, params.ServiceID); err != nil {
-		return nil, err
+		return err
 	}
 
-	return &inventorypb.ChangeServiceResponse{}, nil
+	return nil
 }
 
 func (ss *ServicesService) updateScrapeConfig(ctx context.Context, serviceID string) error {