featuretoggle

README

This package supports the Feature toggle admin page feature.

In order to update feature toggles through the app, the PATCH handler calls a webhook that should update Grafana's configuration and restarts the instance.

For local development, set the app mode to development by adding app_mode = development to the top level of your Grafana .ini file.

Documentation

Index

• func NewFeaturesStorage() *featuresStorage
• func NewTogglesStorage(features *featuremgmt.FeatureManager) *togglesStorage
• type FeatureFlagAPIBuilder
  • func NewFeatureFlagAPIBuilder(features *featuremgmt.FeatureManager, ...) *FeatureFlagAPIBuilder
  • func RegisterAPIService(features *featuremgmt.FeatureManager, ...) *FeatureFlagAPIBuilder
  • func (b *FeatureFlagAPIBuilder) GetAPIGroupInfo(scheme *runtime.Scheme, codecs serializer.CodecFactory, ...) (*genericapiserver.APIGroupInfo, error)
  • func (b *FeatureFlagAPIBuilder) GetAPIRoutes() *builder.APIRoutes
  • func (b *FeatureFlagAPIBuilder) GetAuthorizer() authorizer.Authorizer
  • func (b *FeatureFlagAPIBuilder) GetDesiredDualWriterMode(dualWrite bool, modeMap map[string]grafanarest.DualWriterMode) grafanarest.DualWriterMode
  • func (b *FeatureFlagAPIBuilder) GetGroupVersion() schema.GroupVersion
  • func (b *FeatureFlagAPIBuilder) GetOpenAPIDefinitions() common.GetOpenAPIDefinitions
  • func (b *FeatureFlagAPIBuilder) InstallSchema(scheme *runtime.Scheme) error

Functions

func NewFeaturesStorage

func NewFeaturesStorage() *featuresStorage

NOTE! this does not depend on config or any system state! In the future, the existence of features (and their properties) can be defined dynamically

func NewTogglesStorage

func NewTogglesStorage(features *featuremgmt.FeatureManager) *togglesStorage

Types

type FeatureFlagAPIBuilder

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

This is used just so wire has something unique to return

func NewFeatureFlagAPIBuilder

func NewFeatureFlagAPIBuilder(features *featuremgmt.FeatureManager, accessControl accesscontrol.AccessControl, cfg *setting.Cfg) *FeatureFlagAPIBuilder

func RegisterAPIService

func RegisterAPIService(features *featuremgmt.FeatureManager,
	accessControl accesscontrol.AccessControl,
	apiregistration builder.APIRegistrar,
	cfg *setting.Cfg,
) *FeatureFlagAPIBuilder

func (*FeatureFlagAPIBuilder) GetAPIGroupInfo

func (b *FeatureFlagAPIBuilder) GetAPIGroupInfo(
	scheme *runtime.Scheme,
	codecs serializer.CodecFactory,
	_ generic.RESTOptionsGetter,
	_ grafanarest.DualWriterMode,
) (*genericapiserver.APIGroupInfo, error)

func (*FeatureFlagAPIBuilder) GetAPIRoutes

func (b *FeatureFlagAPIBuilder) GetAPIRoutes() *builder.APIRoutes

Register additional routes with the server

func (*FeatureFlagAPIBuilder) GetAuthorizer

func (b *FeatureFlagAPIBuilder) GetAuthorizer() authorizer.Authorizer

func (*FeatureFlagAPIBuilder) GetDesiredDualWriterMode

func (b *FeatureFlagAPIBuilder) GetDesiredDualWriterMode(dualWrite bool, modeMap map[string]grafanarest.DualWriterMode) grafanarest.DualWriterMode

func (*FeatureFlagAPIBuilder) GetGroupVersion

func (b *FeatureFlagAPIBuilder) GetGroupVersion() schema.GroupVersion

func (*FeatureFlagAPIBuilder) GetOpenAPIDefinitions

func (b *FeatureFlagAPIBuilder) GetOpenAPIDefinitions() common.GetOpenAPIDefinitions

func (*FeatureFlagAPIBuilder) InstallSchema

func (b *FeatureFlagAPIBuilder) InstallSchema(scheme *runtime.Scheme) error