factory

Documentation

Index

• func NewFunc(config interface{}, dependencies factory.Dependencies, out interface{}) error
• type APIConfig
• type Components
• 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 orchestrator.Cluster 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 Components

type Components struct {
	// Nodes contains configuration to instance a Nodes implementation using a factory.
	Nodes *factory.Config `yaml:"nodes"`

	// Pods is a configuration to instance a Pods implementation.
	Pods *factory.Config `yaml:"pods"`

	// Ingresses is a configuration to instance a Ingresses implementation.
	Ingresses *factory.Config `yaml:"ingresses"`

	// IngressRules is a configuration to instance a IngressRules implementation.
	IngressRules *factory.Config `yaml:"ingressRules"`

	// Services is a configuration to instance a Services implementation.
	Services *factory.Config `yaml:"services"`

	// NetworkPolicies is a configuration to instance a NetworkPolicies implementation.
	NetworkPolicies *factory.Config `yaml:"networkPolicies"`

	// Configurations is a configuration to instance a Configurations implementation.
	Configurations *factory.Config `yaml:"configurations"`
}

Components contains factory configs used to create cluster components.

type Config

type Config struct {
	// API contains configuration values used to initialize a Kubernetes API.
	API APIConfig

	// Components contains configuration information for different Cluster components.
	Components Components
}

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.
	// If API is not provided, an API instance will be created using the configuration defined in the Config object.
	API kubeapi.Interface
}

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.