config

Documentation

Index

• Constants
• Variables
• type Backup
• type Client
  • func (r *Client) Read() (*Config, error)
• type Config
• type Context
• type Global
• type Group
• type GroupItem
• type History
• type Selection
• type Source
• type SourceItem
• type State

Constants

const (
	DefaultStateHistoryLimit   = 10
	DefaultBackupRevisionLimit = 10
)

Variables

var (
	DefaultConfigPath = filepath.Join(xdg.ConfigHome, "kontext", "kontext.yaml")
)

Types

type Backup

type Backup struct {
	// enable/disable the backup, defaults to true
	Enabled bool `json:"enabled"`
	// set the backup directory
	Directory string `json:"directory,omitempty"`
	// set the maximum backup revision count
	Revisions int `json:"revisions,omitempty"`
}

Backup configuration options

type Client

type Client struct {
	// File of the file, that will be used to read the configuration
	File string
}

func (*Client) Read

func (r *Client) Read() (*Config, error)

Read reads the current config file and serialize it with koanf

type Config

type Config struct {
	Global Global `json:"global,omitempty"`
	State  State  `json:"state,omitempty"`
	Backup Backup `json:"backup,omitempty"`
	Group  Group  `json:"group,omitempty"`
	Source Source `json:"source,omitempty"`
}

type Context

type Context struct {
	Default   string    `json:"default"`
	Selection Selection `json:"selection"`
}

type Global

type Global struct {
	Kubeconfig string `json:"kubeconfig,omitempty"`
}

type Group

type Group struct {
	Items     []GroupItem `json:"items"`
	Selection Selection   `json:"selection"`
}

Group configuration Options

type GroupItem

type GroupItem struct {
	Name    string   `json:"name"`
	Context Context  `json:"context,omitempty"`
	Sources []string `json:"sources"`
}

type History

type History struct {
	// set the maximum history size
	Size int `json:"size"`
}

type Selection

type Selection struct {
	Default string `json:"default"`
	Sort    string `json:"sort"`
}

type Source

type Source struct {
	Items []SourceItem `json:"items"`
}

Source configuration options

type SourceItem

type SourceItem struct {
	Name    string   `json:"name"`
	Include []string `json:"include,omitempty"`
	Exclude []string `json:"exclude"`
}

type State

type State struct {
	// path of the state file
	File    string  `json:"file,omitempty"`
	History History `json:"history,omitempty"`
}

State configuration options