addons

README

Addons

Addons extend the functionality of kubernetes. You can think of them as plugins that hook into Kubernetes providing new infrastructure services, for example, network connectivity among pods.

Usage

All the go files in this directory (apart from the xxx_test.go files) are equipped with the functions and variables to deploy and configure the addons correctly.

All addons in this directory get deployed automatically by Skuba. They get registered through the init() function, which is called as soon as another package imports the addons package. To learn more about this go functionality read:

https://golang.org/doc/effective_go.html#init

How to create a new Addon

To create a new addon, check the rest of the addons source file to understand what is required. Again, as long as the addon is in this directory, it will get called.

You should also express the version mapping with kubernetes in:

https://github.com/SUSE/skuba/blob/master/internal/pkg/skuba/kubernetes/versions.go

Documentation

Overview

Package addons provides the mechanism to extend the kubernetes functionality by applying addons that provide new functions. This package also includes the addons

Index

• Variables
• func DeployAddons(client clientset.Interface, addonConfiguration AddonConfiguration, ...) error
• func GetCiliumImage(imageTag string) string
• func GetCiliumInitImage(imageTag string) string
• func GetCiliumOperatorImage(imageTag string) string
• func GetDexImage(imageTag string) string
• func GetGangwayImage(imageTag string) string
• func GetKuredImage(imageTag string) string
• type Addon
  • func (addon Addon) Apply(client clientset.Interface, addonConfiguration AddonConfiguration, ...) error
  • func (addon Addon) HasToBeApplied(addonConfiguration AddonConfiguration, ...) (bool, error)
  • func (addon Addon) Images(imageTag string) []string
  • func (addon Addon) IsPresentForClusterVersion(clusterVersion *version.Version) bool
  • func (addon Addon) Render(addonConfiguration AddonConfiguration) (string, error)
  • func (addon Addon) Write(addonConfiguration AddonConfiguration) error
• type AddonConfiguration
• type ApplyBehavior

Variables

var Addons = map[kubernetes.Addon]Addon{}

Functions

func DeployAddons

func DeployAddons(client clientset.Interface, addonConfiguration AddonConfiguration, applyBehavior ApplyBehavior) error

DeployAddons loops over the sorted list of addons, checks if each needs to be deployed and triggers its deployment

func GetCiliumImage

func GetCiliumImage(imageTag string) string

func GetCiliumInitImage

func GetCiliumInitImage(imageTag string) string

func GetCiliumOperatorImage

func GetCiliumOperatorImage(imageTag string) string

func GetDexImage

func GetDexImage(imageTag string) string

func GetGangwayImage

func GetGangwayImage(imageTag string) string

func GetKuredImage

func GetKuredImage(imageTag string) string

Types

type Addon

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

func (Addon) Apply

func (addon Addon) Apply(client clientset.Interface, addonConfiguration AddonConfiguration, skubaConfiguration *skuba.SkubaConfiguration, applyBehavior ApplyBehavior) error

Apply deploys the addon by calling kubectl apply and pointing to the generated addon manifest

func (Addon) HasToBeApplied

func (addon Addon) HasToBeApplied(addonConfiguration AddonConfiguration, skubaConfiguration *skuba.SkubaConfiguration) (bool, error)

HasToBeApplied decides if the Addon is deployed by checking its version with addonVersionLower

func (Addon) Images

func (addon Addon) Images(imageTag string) []string

Images returns the images required for this Addon to properly function

func (Addon) IsPresentForClusterVersion

func (addon Addon) IsPresentForClusterVersion(clusterVersion *version.Version) bool

IsPresentForClusterVersion verifies if the Addon can be deployed with the current k8s version

func (Addon) Render

func (addon Addon) Render(addonConfiguration AddonConfiguration) (string, error)

Render substitutes the variables in the template and returns a string with the addon manifest ready

func (Addon) Write

func (addon Addon) Write(addonConfiguration AddonConfiguration) error

Write creates the manifest yaml file of the Addon after rendering its template

type AddonConfiguration

type AddonConfiguration struct {
	ClusterVersion *version.Version
	ControlPlane   string
	ClusterName    string
}

type ApplyBehavior

type ApplyBehavior uint

const (
	// This is the default behavior for all operations except for Bootstrap,
	// the addon is always re-rendered prior to being applied. In an addons
	// upgrade operation for example, we always want to re-render the latest
	// contents and never reuse local file contents in case the upgrade was
	// executed inside a cluster definition folder
	AlwaysRender ApplyBehavior = iota
	// This is the desired behavior for Bootstrap, when the user can tweak
	// the addon configurations after `skuba cluster init`, so
	// `skuba node bootstrap` will apply the modified settings instead of
	// re-rendering them forcefully
	SkipRenderIfConfigFilePresent ApplyBehavior = iota
)