migrations

Documentation

Index

• type DataSourceSecretMigrationService
  • func ProvideDataSourceMigrationService(dataSourcesService datasources.DataSourceService, kvStore kvstore.KVStore, ...) *DataSourceSecretMigrationService
  • func (s *DataSourceSecretMigrationService) Migrate(ctx context.Context) error
• type MigrateFromPluginService
  • func ProvideMigrateFromPluginService(cfg *setting.Cfg, sqlStore sqlstore.Store, secretsService secrets.Service, ...) *MigrateFromPluginService
  • func (s *MigrateFromPluginService) Migrate(ctx context.Context) error
• type MigrateToPluginService
  • func ProvideMigrateToPluginService(secretsStore secretskvs.SecretsKVStore, cfg *setting.Cfg, ...) *MigrateToPluginService
  • func (s *MigrateToPluginService) Migrate(ctx context.Context) error
• type SecretMigrationProvider
• type SecretMigrationProviderImpl
  • func ProvideSecretMigrationProvider(cfg *setting.Cfg, serverLockService *serverlock.ServerLockService, ...) *SecretMigrationProviderImpl
  • func (s *SecretMigrationProviderImpl) Migrate(ctx context.Context) error
  • func (s *SecretMigrationProviderImpl) Run(ctx context.Context) error
  • func (s *SecretMigrationProviderImpl) TriggerPluginMigration(ctx context.Context, toPlugin bool) error
• type SecretMigrationService

Types

type DataSourceSecretMigrationService

type DataSourceSecretMigrationService struct {
	// contains filtered or unexported fields
}

func ProvideDataSourceMigrationService

func ProvideDataSourceMigrationService(
	dataSourcesService datasources.DataSourceService,
	kvStore kvstore.KVStore,
	features featuremgmt.FeatureToggles,
) *DataSourceSecretMigrationService

func (*DataSourceSecretMigrationService) Migrate

func (s *DataSourceSecretMigrationService) Migrate(ctx context.Context) error

type MigrateFromPluginService

type MigrateFromPluginService struct {
	// contains filtered or unexported fields
}

MigrateFromPluginService This migrator will handle migration of the configured plugin secrets back to Grafana unified secrets

func ProvideMigrateFromPluginService

func ProvideMigrateFromPluginService(
	cfg *setting.Cfg,
	sqlStore sqlstore.Store,
	secretsService secrets.Service,
	manager plugins.SecretsPluginManager,
	kvstore kvstore.KVStore,

) *MigrateFromPluginService

func (*MigrateFromPluginService) Migrate

func (s *MigrateFromPluginService) Migrate(ctx context.Context) error

type MigrateToPluginService

type MigrateToPluginService struct {
	// contains filtered or unexported fields
}

MigrateToPluginService This migrator will handle migration of datasource secrets (aka Unified secrets) into the plugin secrets configured

func ProvideMigrateToPluginService

func ProvideMigrateToPluginService(
	secretsStore secretskvs.SecretsKVStore,
	cfg *setting.Cfg,
	sqlStore sqlstore.Store,
	secretsService secrets.Service,
	kvstore kvstore.KVStore,
	manager plugins.SecretsPluginManager,
) *MigrateToPluginService

func (*MigrateToPluginService) Migrate

func (s *MigrateToPluginService) Migrate(ctx context.Context) error

type SecretMigrationProvider

type SecretMigrationProvider interface {
	registry.BackgroundService
	TriggerPluginMigration(ctx context.Context, toPlugin bool) error
}

type SecretMigrationProviderImpl

type SecretMigrationProviderImpl struct {
	ServerLockService *serverlock.ServerLockService
	// contains filtered or unexported fields
}

func ProvideSecretMigrationProvider

func ProvideSecretMigrationProvider(
	cfg *setting.Cfg,
	serverLockService *serverlock.ServerLockService,
	dataSourceSecretMigrationService *DataSourceSecretMigrationService,
	migrateToPluginService *MigrateToPluginService,
	migrateFromPluginService *MigrateFromPluginService,
) *SecretMigrationProviderImpl

func (*SecretMigrationProviderImpl) Migrate

func (s *SecretMigrationProviderImpl) Migrate(ctx context.Context) error

Migrate Run migration services. This will block until all services have exited. This should only be called once at startup

func (*SecretMigrationProviderImpl) Run

func (s *SecretMigrationProviderImpl) Run(ctx context.Context) error

func (*SecretMigrationProviderImpl) TriggerPluginMigration

func (s *SecretMigrationProviderImpl) TriggerPluginMigration(ctx context.Context, toPlugin bool) error

TriggerPluginMigration Kick off a migration to or from the plugin. This will block until all services have exited.

type SecretMigrationService

type SecretMigrationService interface {
	Migrate(ctx context.Context) error
}

SecretMigrationService is used to migrate legacy secrets to new unified secrets.