config

Documentation

Index

• Constants
• func CheckCatalogDir(catalogDir string) error
• func LoadFile[T any](file string, value *T) error
• func ToContext(parent context.Context, cfg *Config) context.Context
• func ToFlagsContext(parent context.Context, flags *GlobalFlags) context.Context
• type Catalog
• type ColumnWidths
  • func (c ColumnWidths) Get(narrow, wide bool) int
• type Config
  • func FromContext(ctx context.Context) *Config
  • func Load(configDir, catalogDir string) (*Config, error)
  • func (config *Config) KnownChartRefs() []string
  • func (cfg Config) Validate() error
• type EnvironmentTemplates
• type Environments
• type GlobalFlags
  • func FlagsFromContext(ctx context.Context) *GlobalFlags
• type Help
• type ProjectTemplates
• type ReleasePromoteTemplates
• type ReleaseTemplates
• type Releases
• type Templates
• type User
  • func (user User) Save() error
• type ValueMapping
  • func (mapping *ValueMapping) UnmarshalYAML(node *yaml.Node) error

Constants

const (
	CatalogConfigFile = "joy.yaml"
	JoyrcFile         = ".joyrc"
	JoyDefaultDir     = ".joy"
)

const (
	DefaultNarrowColumnWidth = 20
	DefaultNormalColumnWidth = 40
	DefaultWideColumnWidth   = 80
)

Functions

func CheckCatalogDir

func CheckCatalogDir(catalogDir string) error

TODO: maybe this function belongs in package catalog?

func LoadFile

func LoadFile[T any](file string, value *T) error

func ToContext

func ToContext(parent context.Context, cfg *Config) context.Context

func ToFlagsContext

func ToFlagsContext(parent context.Context, flags *GlobalFlags) context.Context

Types

type Catalog

type Catalog struct {
	// MinVersion is the minimum version of the joy CLI required
	MinVersion string `yaml:"minVersion,omitempty"`

	// Charts are the known charts that environments and releases can reference
	Charts map[string]helm.Chart `yaml:"charts,omitempty"`

	// DefaultChartRef refers to the chart that must be used from Charts if a release doesn't specify any chart configuration
	DefaultChartRef string `yaml:"defaultChartRef,omitempty"`

	// ReferenceEnvironment is the name of the environment which represents master in git.
	// IE: if you deploy by default to an environment called "testing" when merging to your main remote branch
	// then referenceEnvironment should be "testing". This setting allows release versions to be compared to main version.
	ReferenceEnvironment string `yaml:"referenceEnvironment,omitempty"`

	// ValueMapping are used to apply parameters to the chart values. The values of the mapping
	// can use the Release and Environment as template values. Chart mappings will not override values
	// already present in the chart.
	// For example:
	//
	//   image.tag: {{ .Release.Spec.Version }}
	//   common.annotations.example\.com/custom: true
	//
	ValueMapping *ValueMapping `yaml:"valueMapping,omitempty"`

	RepositoriesDir string `yaml:"repositoriesDir,omitempty"`

	// Default GitHub organization to infer the repository from the project name.
	GitHubOrganization string `yaml:"gitHubOrganization,omitempty"`

	Templates Templates `yaml:"templates,omitempty"`

	Helps map[string][]Help `yaml:"help,omitempty"`
}

type ColumnWidths

type ColumnWidths struct {
	Narrow int `yaml:"narrow,omitempty"`
	Normal int `yaml:"normal,omitempty"`
	Wide   int `yaml:"wide,omitempty"`
}

func (ColumnWidths) Get

func (c ColumnWidths) Get(narrow, wide bool) int

type Config

type Config struct {
	User
	Catalog

	JoyCache string
}

func FromContext

func FromContext(ctx context.Context) *Config

func Load

func Load(configDir, catalogDir string) (*Config, error)

Load loads config from given configDir (or user home if not specified) and optionally overrides loaded config's catalog directory with given catalogDir, defaulting to ~/.joy if not specified.

func (*Config) KnownChartRefs

func (config *Config) KnownChartRefs() []string

func (Config) Validate

func (cfg Config) Validate() error

type EnvironmentTemplates

type EnvironmentTemplates struct {
	Links map[string]string `yaml:"links,omitempty"`
}

type Environments

type Environments struct {
	// Selected is the list of environments user has selected to work with.
	// Only those will be displayed in table columns by default.
	// An empty list means all environments are selected.
	Selected []string `yaml:"selected,omitempty"`
}

type GlobalFlags

type GlobalFlags struct {
	// SkipCatalogUpdate global flag used to skip catalog update and dirty check.
	SkipCatalogUpdate bool
}

func FlagsFromContext

func FlagsFromContext(ctx context.Context) *GlobalFlags

type Help

type Help struct {
	// ErrorPattern is an optional regex pattern to match against the error message to determine if this help message should be displayed.
	ErrorPattern string `yaml:"error,omitempty"`

	// Message is the help message to display.
	Message string `yaml:"message,omitempty"`
}

type ProjectTemplates

type ProjectTemplates struct {
	GitTag string            `yaml:"gitTag,omitempty"`
	Links  map[string]string `yaml:"links,omitempty"`
}

type ReleasePromoteTemplates

type ReleasePromoteTemplates struct {
	Commit      string `yaml:"commit,omitempty"`
	PullRequest string `yaml:"pullRequest,omitempty"`
}

type ReleaseTemplates

type ReleaseTemplates struct {
	Promote ReleasePromoteTemplates `yaml:"promote,omitempty"`
	Links   map[string]string       `yaml:"links,omitempty"`
}

type Releases

type Releases struct {
	// Selected is the list of releases user has selected to work with.
	// Only those will be displayed in table rows by default.
	// An empty list means all releases are selected.
	Selected []string `yaml:"selected,omitempty"`
}

type Templates

type Templates struct {
	Environment EnvironmentTemplates `yaml:"environment,omitempty"`
	Project     ProjectTemplates     `yaml:"project,omitempty"`
	Release     ReleaseTemplates     `yaml:"release,omitempty"`
}

type User

type User struct {
	// CatalogDir is the directory containing catalog of environments, projects and releases.
	// Optional, defaults to ~/.joy
	CatalogDir string `yaml:"catalogDir,omitempty"`

	// Environments user has selected to work with.
	Environments Environments `yaml:"environments,omitempty"`

	// Releases user has selected to work with.
	Releases Releases `yaml:"releases,omitempty"`

	ColumnWidths ColumnWidths `yaml:"columnWidths,omitempty"`

	// FilePath is the path to the config file that was loaded, used to write back to the same file.
	FilePath string `yaml:"-"`
}

func (User) Save

func (user User) Save() error

Save saves config back to its original file.

type ValueMapping

type ValueMapping struct {
	ReleaseIgnoreList []string
	Mappings          map[string]any
}

func (*ValueMapping) UnmarshalYAML

func (mapping *ValueMapping) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML provides custom unmarshalling for backwards compatibility with map[string]string valueMappings. This is a stop gap so that we do not break the current joy CLI interpretation of the catalog. However, this will enable us to add a releaseIgnoreList to ignore injecting default values into charts that would otherwise break.