flexkube

Documentation

Overview

Package flexkube contains logic of 'flexkube' CLI.

Index

• Constants
• func Run(args []string) int
• type Resource
  • func LoadResourceFromFiles() (*Resource, error)
  • func (r *Resource) Kubeconfig() (string, error)
  • func (r *Resource) RunAPILoadBalancerPool(name string) error
  • func (r *Resource) RunContainers(name string) error
  • func (r *Resource) RunControlplane() error
  • func (r *Resource) RunEtcd() error
  • func (r *Resource) RunKubeletPool(name string) error
  • func (r *Resource) RunPKI() error
  • func (r *Resource) StateToFile(actionErr error) error
  • func (r *Resource) Template(templateContent string) (string, error)
  • func (r *Resource) TemplateFromFile(templatePath string) (string, error)
• type ResourceState

Constants

const (
	// Version is a version printed by the --version flag.
	Version = "v0.10.0"

	// YesFlag is a const for --yes flag.
	YesFlag = "yes"

	// NoopFlag is const for --noop flag.
	NoopFlag = "noop"
)

Functions

func Run

func Run(args []string) int

Run executes flexkube CLI binary with given arguments (usually os.Args).

Types

type Resource

type Resource struct {
	// Etcd allows to manage etcd cluster, which is required for running Kubernetes.
	//
	// See etcd.Cluster for available fields.
	Etcd *etcd.Cluster `json:"etcd,omitempty"`

	// Controlplane allows to manage static Kubernetes controlplane, which consists of kube-apiserver,
	// kube-scheduler and kube-controller-manager.
	//
	// Usually single controlplane is created, which can be then used to install self-hosted controlplane
	// e.g. using 'helm'.
	//
	// See controlplane.Controlplane for available fields.
	Controlplane *controlplane.Controlplane `json:"controlplane,omitempty"`

	// PKI allows to manage certificates and private keys required by Kubernetes.
	//
	// See pki.PKI for available fields.
	PKI *pki.PKI `json:"pki,omitempty"`

	// KubeletPools allows to manage multiple kubelet pools. In case of self-hosted Kubernetes, you usually want to
	// run at least 2 pools, which differs in labels. One for controller nodes, which runs for example kube-apiserver
	// and other pods, which have access to cluster credentials and another one for worker nodes.
	//
	// Creating more worker pools is useful, if you have group of cluster nodes with different hardware.
	//
	// See kubelet.Pool for available fields.
	KubeletPools map[string]*kubelet.Pool `json:"kubeletPools,omitempty"`

	// APILoadBalancerPools allows to manage multiple kube-apiserver load balancers, which allows building
	// highly available Kubernetes clusters.
	//
	// For example, kubelet does not support load-balancing internally, so it can be pointed to load balancer
	// address, which will handle graceful handover in case of one API server going down.
	//
	// See apiloadbalancer.APILoadBalancers for available fields.
	APILoadBalancerPools map[string]*apiloadbalancer.APILoadBalancers `json:"apiLoadBalancerPools,omitempty"`

	// Containers allows to manage arbitrary container groups. This is useful, when you need some extra
	// containers to run as part of your Kubernetes cluster. For example, when running with cloud-controller-manager
	// it can be used to run static instance of it for bootstrapping.
	//
	// See container.ContainersState for available options.
	Containers map[string]*container.ContainersState `json:"containers,omitempty"`

	// State stores state of all configured resources. Information about all created containers and generated certificates
	// must be persisted, so it does not change on consecutive runs.
	State *ResourceState `json:"state,omitempty"`

	// Confirmed controls, if user should be asked for confirmation input before applying changes.
	// Set to 'true' for unattended runs.
	Confirmed bool `json:"confirmed,omitempty"`

	// Noop controls, if deployment should actually be executed. If set to 'true', only the difference between
	// cluster existing state and desired state will be printed, but the State field won't be modified.
	Noop bool `json:"noop,omitempty"`
}

Resource represents flexkube CLI configuration structure.

func LoadResourceFromFiles

func LoadResourceFromFiles() (*Resource, error)

LoadResourceFromFiles loads Resource struct from config.yaml and state.yaml files.

func (*Resource) Kubeconfig

func (r *Resource) Kubeconfig() (string, error)

Kubeconfig generates content of kubeconfig file in YAML format from Controlplane and PKI configuration.

func (*Resource) RunAPILoadBalancerPool

func (r *Resource) RunAPILoadBalancerPool(name string) error

RunAPILoadBalancerPool deploys given API Load Balancer pool.

func (*Resource) RunContainers

func (r *Resource) RunContainers(name string) error

RunContainers deploys given containers group.

func (*Resource) RunControlplane

func (r *Resource) RunControlplane() error

RunControlplane deploys configured static controlplane.

func (*Resource) RunEtcd

func (r *Resource) RunEtcd() error

RunEtcd deploys configured etcd cluster.

func (*Resource) RunKubeletPool

func (r *Resource) RunKubeletPool(name string) error

RunKubeletPool deploys given kubelet pool.

func (*Resource) RunPKI

func (r *Resource) RunPKI() error

RunPKI generates configured PKI.

func (*Resource) StateToFile

func (r *Resource) StateToFile(actionErr error) error

StateToFile saves resource state into state.yaml file.

func (*Resource) Template

func (r *Resource) Template(templateContent string) (string, error)

Template executes given Go template using configuration and state.

func (*Resource) TemplateFromFile

func (r *Resource) TemplateFromFile(templatePath string) (string, error)

TemplateFromFile reads template from a given path and executes it using configuration and state.

type ResourceState

type ResourceState struct {
	// Etcd stores state information about containers which are part of etcd cluster.
	Etcd *container.ContainersState `json:"etcd,omitempty"`

	// Controlplane stores state information about containers which are part Kubernetes static controlplane.
	Controlplane *container.ContainersState `json:"controlplane,omitempty"`

	// KubeletPools stores state information about containers which are part of kubelet pools.
	KubeletPools map[string]*container.ContainersState `json:"kubeletPools,omitempty"`

	// APILoadBalancerPools stores state information about containers which are part of kube-apiserver load
	// balancer pools.
	APILoadBalancerPools map[string]*container.ContainersState `json:"apiLoadBalancerPools,omitempty"`

	// Containers stores state information for configured container groups.
	Containers map[string]*container.ContainersState `json:"containers,omitempty"`

	// PKI stores generated Kubernetes certificates.
	PKI *pki.PKI `json:"pki,omitempty"`
}

ResourceState represents flexkube CLI state format.