configuration

Documentation

Index

• func DefaultConfigPath() (string, error)
• func Write(ketchConfig KetchConfig, path string) error
• type AdditionalBuilder
• type Configuration
  • func (cfg *Configuration) Client() client.Client
  • func (cfg *Configuration) DynamicClient() dynamic.Interface
  • func (cfg *Configuration) KubernetesClient() kubernetes.Interface
  • func (cfg *Configuration) Storage() templates.Client
• type KetchConfig
  • func Read(path string) KetchConfig

Functions

func DefaultConfigPath

func DefaultConfigPath() (string, error)

DefaultConfigPath returns the path to the config.toml file

func Write

func Write(ketchConfig KetchConfig, path string) error

Write writes the provided KetchConfig to the given path. In the event the path is not found it will be created

Types

type AdditionalBuilder

type AdditionalBuilder struct {
	Vendor      string `toml:"vendor" json:"vendor" yaml:"vendor"`
	Image       string `toml:"image" json:"image" yaml:"image"`
	Description string `toml:"description" json:"description" yaml:"description"`
}

AdditionalBuilder contains the information of any user added builders

type Configuration

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

Configuration provides methods to get initialized clients.

func (*Configuration) Client

func (cfg *Configuration) Client() client.Client

Client returns initialized controller-runtime's Client to perform CRUD operations on Kubernetes objects.

func (*Configuration) DynamicClient

func (cfg *Configuration) DynamicClient() dynamic.Interface

DynamicClient returns kubernetes dynamic client. It's used to work with CRDs for which we don't have go types like ClusterIssuer.

func (*Configuration) KubernetesClient

func (cfg *Configuration) KubernetesClient() kubernetes.Interface

KubernetesClient returns kubernetes typed client. It's used to work with standard kubernetes types.

func (*Configuration) Storage

func (cfg *Configuration) Storage() templates.Client

Client returns initialized templates.Client to perform CRUD operations on templates.

type KetchConfig

type KetchConfig struct {
	AdditionalBuilders []AdditionalBuilder `toml:"additional-builders,omitempty"`
	DefaultBuilder     string              `toml:"default-builder,omitempty"`
}

KetchConfig contains all the values present in the config.toml

func Read

func Read(path string) KetchConfig

Read returns a Configuration containing the unmarshalled config.toml file contents