package datastore import ( "fmt" "os" portainer "github.com/portainer/portainer/api" "github.com/portainer/portainer/api/database/models" "github.com/portainer/portainer/api/dataservices" "github.com/portainer/portainer/api/dataservices/apikeyrepository" "github.com/portainer/portainer/api/dataservices/customtemplate" "github.com/portainer/portainer/api/dataservices/dockerhub" "github.com/portainer/portainer/api/dataservices/edgegroup" "github.com/portainer/portainer/api/dataservices/edgejob" "github.com/portainer/portainer/api/dataservices/edgestack" "github.com/portainer/portainer/api/dataservices/endpoint" "github.com/portainer/portainer/api/dataservices/endpointgroup" "github.com/portainer/portainer/api/dataservices/endpointrelation" "github.com/portainer/portainer/api/dataservices/extension" "github.com/portainer/portainer/api/dataservices/helmuserrepository" "github.com/portainer/portainer/api/dataservices/pendingactions" "github.com/portainer/portainer/api/dataservices/registry" "github.com/portainer/portainer/api/dataservices/resourcecontrol" "github.com/portainer/portainer/api/dataservices/role" "github.com/portainer/portainer/api/dataservices/schedule" "github.com/portainer/portainer/api/dataservices/settings" "github.com/portainer/portainer/api/dataservices/snapshot" "github.com/portainer/portainer/api/dataservices/ssl" "github.com/portainer/portainer/api/dataservices/stack" "github.com/portainer/portainer/api/dataservices/tag" "github.com/portainer/portainer/api/dataservices/team" "github.com/portainer/portainer/api/dataservices/teammembership" "github.com/portainer/portainer/api/dataservices/tunnelserver" "github.com/portainer/portainer/api/dataservices/user" "github.com/portainer/portainer/api/dataservices/version" "github.com/portainer/portainer/api/dataservices/webhook" "github.com/rs/zerolog/log" "github.com/segmentio/encoding/json" ) // Store defines the implementation of portainer.DataStore using // BoltDB as the storage system. type Store struct { connection portainer.Connection fileService portainer.FileService CustomTemplateService *customtemplate.Service DockerHubService *dockerhub.Service EdgeGroupService *edgegroup.Service EdgeJobService *edgejob.Service EdgeStackService *edgestack.Service EndpointGroupService *endpointgroup.Service EndpointService *endpoint.Service EndpointRelationService *endpointrelation.Service ExtensionService *extension.Service HelmUserRepositoryService *helmuserrepository.Service RegistryService *registry.Service ResourceControlService *resourcecontrol.Service RoleService *role.Service APIKeyRepositoryService *apikeyrepository.Service ScheduleService *schedule.Service SettingsService *settings.Service SnapshotService *snapshot.Service SSLSettingsService *ssl.Service StackService *stack.Service TagService *tag.Service TeamMembershipService *teammembership.Service TeamService *team.Service TunnelServerService *tunnelserver.Service UserService *user.Service VersionService *version.Service WebhookService *webhook.Service PendingActionsService *pendingactions.Service } func (store *Store) initServices() error { authorizationsetService, err := role.NewService(store.connection) if err != nil { return err } store.RoleService = authorizationsetService customTemplateService, err := customtemplate.NewService(store.connection) if err != nil { return err } store.CustomTemplateService = customTemplateService dockerhubService, err := dockerhub.NewService(store.connection) if err != nil { return err } store.DockerHubService = dockerhubService endpointRelationService, err := endpointrelation.NewService(store.connection) if err != nil { return err } store.EndpointRelationService = endpointRelationService edgeStackService, err := edgestack.NewService(store.connection, endpointRelationService.InvalidateEdgeCacheForEdgeStack) if err != nil { return err } store.EdgeStackService = edgeStackService endpointRelationService.RegisterUpdateStackFunction(edgeStackService.UpdateEdgeStackFunc, edgeStackService.UpdateEdgeStackFuncTx) edgeGroupService, err := edgegroup.NewService(store.connection) if err != nil { return err } store.EdgeGroupService = edgeGroupService edgeJobService, err := edgejob.NewService(store.connection) if err != nil { return err } store.EdgeJobService = edgeJobService endpointgroupService, err := endpointgroup.NewService(store.connection) if err != nil { return err } store.EndpointGroupService = endpointgroupService endpointService, err := endpoint.NewService(store.connection) if err != nil { return err } store.EndpointService = endpointService extensionService, err := extension.NewService(store.connection) if err != nil { return err } store.ExtensionService = extensionService helmUserRepositoryService, err := helmuserrepository.NewService(store.connection) if err != nil { return err } store.HelmUserRepositoryService = helmUserRepositoryService registryService, err := registry.NewService(store.connection) if err != nil { return err } store.RegistryService = registryService resourcecontrolService, err := resourcecontrol.NewService(store.connection) if err != nil { return err } store.ResourceControlService = resourcecontrolService settingsService, err := settings.NewService(store.connection) if err != nil { return err } store.SettingsService = settingsService snapshotService, err := snapshot.NewService(store.connection) if err != nil { return err } store.SnapshotService = snapshotService sslSettingsService, err := ssl.NewService(store.connection) if err != nil { return err } store.SSLSettingsService = sslSettingsService stackService, err := stack.NewService(store.connection) if err != nil { return err } store.StackService = stackService tagService, err := tag.NewService(store.connection) if err != nil { return err } store.TagService = tagService teammembershipService, err := teammembership.NewService(store.connection) if err != nil { return err } store.TeamMembershipService = teammembershipService teamService, err := team.NewService(store.connection) if err != nil { return err } store.TeamService = teamService tunnelServerService, err := tunnelserver.NewService(store.connection) if err != nil { return err } store.TunnelServerService = tunnelServerService userService, err := user.NewService(store.connection) if err != nil { return err } store.UserService = userService apiKeyService, err := apikeyrepository.NewService(store.connection) if err != nil { return err } store.APIKeyRepositoryService = apiKeyService versionService, err := version.NewService(store.connection) if err != nil { return err } store.VersionService = versionService webhookService, err := webhook.NewService(store.connection) if err != nil { return err } store.WebhookService = webhookService scheduleService, err := schedule.NewService(store.connection) if err != nil { return err } store.ScheduleService = scheduleService pendingActionsService, err := pendingactions.NewService(store.connection) if err != nil { return err } store.PendingActionsService = pendingActionsService return nil } // PendingActions gives access to the PendingActions data management layer func (store *Store) PendingActions() dataservices.PendingActionsService { return store.PendingActionsService } // CustomTemplate gives access to the CustomTemplate data management layer func (store *Store) CustomTemplate() dataservices.CustomTemplateService { return store.CustomTemplateService } // EdgeGroup gives access to the EdgeGroup data management layer func (store *Store) EdgeGroup() dataservices.EdgeGroupService { return store.EdgeGroupService } // EdgeJob gives access to the EdgeJob data management layer func (store *Store) EdgeJob() dataservices.EdgeJobService { return store.EdgeJobService } // EdgeStack gives access to the EdgeStack data management layer func (store *Store) EdgeStack() dataservices.EdgeStackService { return store.EdgeStackService } // Environment(Endpoint) gives access to the Environment(Endpoint) data management layer func (store *Store) Endpoint() dataservices.EndpointService { return store.EndpointService } // EndpointGroup gives access to the EndpointGroup data management layer func (store *Store) EndpointGroup() dataservices.EndpointGroupService { return store.EndpointGroupService } // EndpointRelation gives access to the EndpointRelation data management layer func (store *Store) EndpointRelation() dataservices.EndpointRelationService { return store.EndpointRelationService } // HelmUserRepository access the helm user repository settings func (store *Store) HelmUserRepository() dataservices.HelmUserRepositoryService { return store.HelmUserRepositoryService } // Registry gives access to the Registry data management layer func (store *Store) Registry() dataservices.RegistryService { return store.RegistryService } // ResourceControl gives access to the ResourceControl data management layer func (store *Store) ResourceControl() dataservices.ResourceControlService { return store.ResourceControlService } // Role gives access to the Role data management layer func (store *Store) Role() dataservices.RoleService { return store.RoleService } // APIKeyRepository gives access to the api-key data management layer func (store *Store) APIKeyRepository() dataservices.APIKeyRepository { return store.APIKeyRepositoryService } // Settings gives access to the Settings data management layer func (store *Store) Settings() dataservices.SettingsService { return store.SettingsService } func (store *Store) Snapshot() dataservices.SnapshotService { return store.SnapshotService } // SSLSettings gives access to the SSL Settings data management layer func (store *Store) SSLSettings() dataservices.SSLSettingsService { return store.SSLSettingsService } // Stack gives access to the Stack data management layer func (store *Store) Stack() dataservices.StackService { return store.StackService } // Tag gives access to the Tag data management layer func (store *Store) Tag() dataservices.TagService { return store.TagService } // TeamMembership gives access to the TeamMembership data management layer func (store *Store) TeamMembership() dataservices.TeamMembershipService { return store.TeamMembershipService } // Team gives access to the Team data management layer func (store *Store) Team() dataservices.TeamService { return store.TeamService } // TunnelServer gives access to the TunnelServer data management layer func (store *Store) TunnelServer() dataservices.TunnelServerService { return store.TunnelServerService } // User gives access to the User data management layer func (store *Store) User() dataservices.UserService { return store.UserService } // Version gives access to the Version data management layer func (store *Store) Version() dataservices.VersionService { return store.VersionService } // Webhook gives access to the Webhook data management layer func (store *Store) Webhook() dataservices.WebhookService { return store.WebhookService } type storeExport struct { CustomTemplate []portainer.CustomTemplate `json:"customtemplates,omitempty"` EdgeGroup []portainer.EdgeGroup `json:"edgegroups,omitempty"` EdgeJob []portainer.EdgeJob `json:"edgejobs,omitempty"` EdgeStack []portainer.EdgeStack `json:"edge_stack,omitempty"` Endpoint []portainer.Endpoint `json:"endpoints,omitempty"` EndpointGroup []portainer.EndpointGroup `json:"endpoint_groups,omitempty"` EndpointRelation []portainer.EndpointRelation `json:"endpoint_relations,omitempty"` Extensions []portainer.Extension `json:"extension,omitempty"` HelmUserRepository []portainer.HelmUserRepository `json:"helm_user_repository,omitempty"` Registry []portainer.Registry `json:"registries,omitempty"` ResourceControl []portainer.ResourceControl `json:"resource_control,omitempty"` Role []portainer.Role `json:"roles,omitempty"` Schedules []portainer.Schedule `json:"schedules,omitempty"` Settings portainer.Settings `json:"settings,omitempty"` Snapshot []portainer.Snapshot `json:"snapshots,omitempty"` SSLSettings portainer.SSLSettings `json:"ssl,omitempty"` Stack []portainer.Stack `json:"stacks,omitempty"` Tag []portainer.Tag `json:"tags,omitempty"` TeamMembership []portainer.TeamMembership `json:"team_membership,omitempty"` Team []portainer.Team `json:"teams,omitempty"` TunnelServer portainer.TunnelServerInfo `json:"tunnel_server,omitempty"` User []portainer.User `json:"users,omitempty"` Version models.Version `json:"version,omitempty"` Webhook []portainer.Webhook `json:"webhooks,omitempty"` Metadata map[string]any `json:"metadata,omitempty"` } func (store *Store) Export(filename string) (err error) { backup := storeExport{} if c, err := store.CustomTemplate().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Custom Templates") } } else { backup.CustomTemplate = c } if e, err := store.EdgeGroup().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Edge Groups") } } else { backup.EdgeGroup = e } if e, err := store.EdgeJob().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Edge Jobs") } } else { backup.EdgeJob = e } if e, err := store.EdgeStack().EdgeStacks(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Edge Stacks") } } else { backup.EdgeStack = e } if e, err := store.Endpoint().Endpoints(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Endpoints") } } else { backup.Endpoint = e } if e, err := store.EndpointGroup().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Endpoint Groups") } } else { backup.EndpointGroup = e } if r, err := store.EndpointRelation().EndpointRelations(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Endpoint Relations") } } else { backup.EndpointRelation = r } if r, err := store.ExtensionService.Extensions(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Extensions") } } else { backup.Extensions = r } if r, err := store.HelmUserRepository().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Helm User Repositories") } } else { backup.HelmUserRepository = r } if r, err := store.Registry().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Registries") } } else { backup.Registry = r } if c, err := store.ResourceControl().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Resource Controls") } } else { backup.ResourceControl = c } if role, err := store.Role().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Roles") } } else { backup.Role = role } if r, err := store.ScheduleService.Schedules(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Schedules") } } else { backup.Schedules = r } if settings, err := store.Settings().Settings(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Settings") } } else { backup.Settings = *settings } if snapshot, err := store.Snapshot().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Snapshots") } } else { backup.Snapshot = snapshot } if settings, err := store.SSLSettings().Settings(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting SSL Settings") } } else { backup.SSLSettings = *settings } if t, err := store.Stack().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Stacks") } } else { backup.Stack = t } if t, err := store.Tag().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Tags") } } else { backup.Tag = t } if t, err := store.TeamMembership().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Team Memberships") } } else { backup.TeamMembership = t } if t, err := store.Team().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Teams") } } else { backup.Team = t } if info, err := store.TunnelServer().Info(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Tunnel Server") } } else { backup.TunnelServer = *info } if users, err := store.User().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Users") } } else { backup.User = users } if webhooks, err := store.Webhook().ReadAll(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Webhooks") } } else { backup.Webhook = webhooks } if version, err := store.Version().Version(); err != nil { if !store.IsErrObjectNotFound(err) { log.Error().Err(err).Msg("exporting Version") } } else { backup.Version = *version } backup.Metadata, err = store.connection.BackupMetadata() if err != nil { log.Error().Err(err).Msg("exporting Metadata") } b, err := json.MarshalIndent(backup, "", " ") if err != nil { return err } return os.WriteFile(filename, b, 0600) } func (store *Store) Import(filename string) (err error) { backup := storeExport{} s, err := os.ReadFile(filename) if err != nil { return err } err = json.Unmarshal(s, &backup) if err != nil { return err } store.Version().UpdateVersion(&backup.Version) for _, v := range backup.CustomTemplate { store.CustomTemplate().Update(v.ID, &v) } for _, v := range backup.EdgeGroup { store.EdgeGroup().Update(v.ID, &v) } for _, v := range backup.EdgeJob { store.EdgeJob().Update(v.ID, &v) } for _, v := range backup.EdgeStack { store.EdgeStack().UpdateEdgeStack(v.ID, &v) } for _, v := range backup.Endpoint { store.Endpoint().UpdateEndpoint(v.ID, &v) } for _, v := range backup.EndpointGroup { store.EndpointGroup().Update(v.ID, &v) } for _, v := range backup.EndpointRelation { store.EndpointRelation().UpdateEndpointRelation(v.EndpointID, &v) } for _, v := range backup.HelmUserRepository { store.HelmUserRepository().Update(v.ID, &v) } for _, v := range backup.Registry { store.Registry().Update(v.ID, &v) } for _, v := range backup.ResourceControl { store.ResourceControl().Update(v.ID, &v) } for _, v := range backup.Role { store.Role().Update(v.ID, &v) } store.Settings().UpdateSettings(&backup.Settings) store.SSLSettings().UpdateSettings(&backup.SSLSettings) for _, v := range backup.Snapshot { store.Snapshot().Update(v.EndpointID, &v) } for _, v := range backup.Stack { store.Stack().Update(v.ID, &v) } for _, v := range backup.Tag { store.Tag().Update(v.ID, &v) } for _, v := range backup.TeamMembership { store.TeamMembership().Update(v.ID, &v) } for _, v := range backup.Team { store.Team().Update(v.ID, &v) } store.TunnelServer().UpdateInfo(&backup.TunnelServer) for _, user := range backup.User { if err := store.User().Update(user.ID, &user); err != nil { log.Debug().Str("user", fmt.Sprintf("%+v", user)).Err(err).Msg("failed to update the user in the database") } } for _, v := range backup.Webhook { store.Webhook().Update(v.ID, &v) } return store.connection.RestoreMetadata(backup.Metadata) }