factory

Documentation

Index

• func NewFunc(config interface{}, dependencies factory.Dependencies, out interface{}) error
• type APIConfig
• type Config
  • func (c *Config) Validate() error
• type Dependencies
  • func (d *Dependencies) Validate() error

Functions

func NewFunc

func NewFunc(config interface{}, dependencies factory.Dependencies, out interface{}) error

NewFunc is the factory creation function for the Kubernetes pods.Pods implementation.

Types

type APIConfig

type APIConfig struct {
	// KubeConfig contains the path to the target cluster's kubeconfig file.
	KubeConfig string `yaml:"kubeconfig"`
}

APIConfig contains configuration values used to initialize a Kubernetes API.

type Config

type Config struct {
	// API contains config
	API APIConfig
}

Config is used to create a Kubernetes cluster component.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates that the config values are valid.

type Dependencies

type Dependencies struct {
	// Logger is used to store log information.
	Logger ign.Logger `validate:"required"`

	// API is the Kubernetes clientset.
	API kubeapi.Interface `validate:"required"`

	// SPDY is the SPDY executor initializer. It is required to run commands on pods.
	// If SPDY is not provided, a default SPDY executor will be created.
	SPDY spdy.Initializer
}

Dependencies is used to create a Kubernetes cluster component.

func (*Dependencies) Validate

func (d *Dependencies) Validate() error

Validate validates that the dependencies values are valid.