cliconfig

Documentation

Index

• Constants
• func CortexEndpointValidator(val string) (string, error)
• func ErrorDuplicateEnvironmentNames(envName string) error
• func ErrorEnvironmentAlreadyConfigured(envName string) error
• func ErrorEnvironmentNotConfigured(envName string) error
• type CLIConfig
  • func (cliConfig *CLIConfig) ConvertToUserFacingCLIConfig() UserFacingCLIConfig
  • func (cliConfig *CLIConfig) Validate() error
• type Environment
  • func (env Environment) String(isDefault bool) string
  • func (env *Environment) Validate() error
• type UserFacingCLIConfig

Constants

const (
	EnvironmentsKey       = "environments"
	DefaultEnvironmentKey = "default_environment"
	NameKey               = "name"
	OperatorEndpointKey   = "operator_endpoint"
)

const (
	ErrEnvironmentNotConfigured     = "cliconfig.environment_not_configured"
	ErrEnvironmentAlreadyConfigured = "cliconfig.environment_already_configured"
	ErrDuplicateEnvironmentNames    = "cliconfig.duplicate_environment_names"
)

Functions

func CortexEndpointValidator

func CortexEndpointValidator(val string) (string, error)

func ErrorDuplicateEnvironmentNames

func ErrorDuplicateEnvironmentNames(envName string) error

func ErrorEnvironmentAlreadyConfigured

func ErrorEnvironmentAlreadyConfigured(envName string) error

func ErrorEnvironmentNotConfigured

func ErrorEnvironmentNotConfigured(envName string) error

Types

type CLIConfig

type CLIConfig struct {
	Telemetry          *bool          `json:"telemetry,omitempty" yaml:"telemetry,omitempty"`
	DefaultEnvironment *string        `json:"default_environment" yaml:"default_environment"`
	Environments       []*Environment `json:"environments" yaml:"environments"`
}

func (*CLIConfig) ConvertToUserFacingCLIConfig

func (cliConfig *CLIConfig) ConvertToUserFacingCLIConfig() UserFacingCLIConfig

func (*CLIConfig) Validate

func (cliConfig *CLIConfig) Validate() error

type Environment

type Environment struct {
	Name             string `json:"name" yaml:"name"`
	OperatorEndpoint string `json:"operator_endpoint" yaml:"operator_endpoint"`
}

func (Environment) String

func (env Environment) String(isDefault bool) string

func (*Environment) Validate

func (env *Environment) Validate() error

type UserFacingCLIConfig

type UserFacingCLIConfig struct {
	DefaultEnvironment *string        `json:"default_environment" yaml:"default_environment"`
	Environments       []*Environment `json:"environments" yaml:"environments"`
}