config

Documentation

Index

• Constants
• func GetProvider(remoteCfgSyncEnabled bool, deployClient DeploymentClient) config.Provider
• func RegisterFlags(flags *pflag.FlagSet)
• type DeploymentClient
• type EnvProvider
  • func NewEnvProvider() *EnvProvider
  • func (e *EnvProvider) Configs(ctx context.Context) (config.YAMLFiles, int, error)
• type FileSystemProvider
  • func NewFileSystemProvider(configs []string) *FileSystemProvider
  • func (e *FileSystemProvider) Configs(_ context.Context) (config.YAMLFiles, int, error)
• type GqlProvider
  • func NewGqlProvider(dc DeploymentClient) *GqlProvider
  • func (g *GqlProvider) Configs(ctx context.Context) (config.YAMLFiles, int, error)

Constants

const (
	// EnvProviderConfigPathsEnvKey holds config paths separated by comma.
	EnvProviderConfigPathsEnvKey = "BOTKUBE_CONFIG_PATHS"
)

Functions

func GetProvider

func GetProvider(remoteCfgSyncEnabled bool, deployClient DeploymentClient) config.Provider

GetProvider resolves and returns paths for config files. It reads them the 'BOTKUBE_CONFIG_PATHS' env variable. If not found, then it uses '--config' flag.

func RegisterFlags

func RegisterFlags(flags *pflag.FlagSet)

RegisterFlags registers config related flags.

Types

type DeploymentClient

type DeploymentClient interface {
	GetConfigWithResourceVersion(ctx context.Context) (remote.Deployment, error)
}

type EnvProvider

type EnvProvider struct {
}

EnvProvider environment config source provider

func NewEnvProvider

func NewEnvProvider() *EnvProvider

NewEnvProvider initializes new environment config source provider

func (*EnvProvider) Configs

func (e *EnvProvider) Configs(ctx context.Context) (config.YAMLFiles, int, error)

Configs returns list of config file locations

type FileSystemProvider

type FileSystemProvider struct {
	Files []string
}

FileSystemProvider allows consumer to pass config files statically

func NewFileSystemProvider

func NewFileSystemProvider(configs []string) *FileSystemProvider

NewFileSystemProvider initializes new static config source provider

func (*FileSystemProvider) Configs

func (e *FileSystemProvider) Configs(_ context.Context) (config.YAMLFiles, int, error)

Configs returns list of config file locations.

type GqlProvider

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

GqlProvider is GraphQL provider

func NewGqlProvider

func NewGqlProvider(dc DeploymentClient) *GqlProvider

NewGqlProvider initializes new GraphQL config source provider

func (*GqlProvider) Configs

func (g *GqlProvider) Configs(ctx context.Context) (config.YAMLFiles, int, error)

Configs returns list of config files