konf

Documentation

Index

• type KonfID
  • func IDFromClusterAndContext(cluster, context string) KonfID
  • func IDFromFileInfo(fi fs.FileInfo) KonfID
  • func IDFromProcessID(pid int) KonfID
  • func (id KonfID) ActivePath() string
  • func (id KonfID) StorePath() string
• type Konfig
  • func KonfsFromKubeconfig(kubeconfig io.Reader) (konfs []*Konfig, err error)

Types

type KonfID

type KonfID string

ID unifies ID and File management that konf uses Currently an ID is defined by the context and clustername of the config, separated by an underscore I have chosen this combination as it is fairly unique among multiple configs. I decided against using just context.name as a lot of times the context is just called "default", which results in lots of naming collisions Some special characters that are reserved by the filesystem, will be replaced by a "-" character

func IDFromClusterAndContext

func IDFromClusterAndContext(cluster, context string) KonfID

IDFromClusterAndContext creates an id based on the cluster and context It escapes any illegal file characters and is filesafe

func IDFromFileInfo

func IDFromFileInfo(fi fs.FileInfo) KonfID

IDFromFileInfo creates an ID from the name of a file

func IDFromProcessID

func IDFromProcessID(pid int) KonfID

IDFromProcessID creates a KonfID based on the supplied processID

func (KonfID) ActivePath

func (id KonfID) ActivePath() string

ActivePath creates a valid filepath inside the configured activeDir

func (KonfID) StorePath

func (id KonfID) StorePath() string

StorePathForID creates a valid filepath inside the configured storeDir

type Konfig

type Konfig struct {
	Id         KonfID
	Kubeconfig k8s.Config
	StorePath  string
}

func KonfsFromKubeconfig

func KonfsFromKubeconfig(kubeconfig io.Reader) (konfs []*Konfig, err error)

KonfsFromKubeconfig takes in the content of a kubeconfig and splits it into one or multiple konfs.

No error is being returned if the kubeconfig contains no contexts, instead konfs is simply an empty slice