cilium

Documentation

Index

• Constants
• func ChangeDiff(currentSpec, newSpec *cluster.Spec) *types.ChangeDiff
• func CheckDaemonSetReady(daemonSet *v1.DaemonSet) error
• func CheckDeploymentReady(deployment *v1.Deployment) error
• func CheckPreflightDaemonSetReady(ciliumDaemonSet, preflightDaemonSet *v1.DaemonSet) error
• type Cilium
  • func NewCilium(client Client, helm Helm) *Cilium
  • func (c *Cilium) GenerateManifest(ctx context.Context, clusterSpec *cluster.Spec, providerNamespaces []string) ([]byte, error)
• type Client
• type ComponentUpgradePlan
  • func (c ComponentUpgradePlan) Needed() bool
• type Helm
• type Installation
  • func (i Installation) Installed() bool
• type ManifestConfig
• type ManifestOpt
  • func WithKubeVersion(kubeVersion string) ManifestOpt
  • func WithPolicyAllowedNamespaces(namespaces []string) ManifestOpt
  • func WithRetrier(retrier *retrier.Retrier) ManifestOpt
  • func WithUpgradeFromVersion(version semver.Version) ManifestOpt
• type Templater
  • func NewTemplater(helm Helm) *Templater
  • func (t *Templater) GenerateManifest(ctx context.Context, spec *cluster.Spec, opts ...ManifestOpt) ([]byte, error)
  • func (t *Templater) GenerateNetworkPolicyManifest(spec *cluster.Spec, namespaces []string) ([]byte, error)
  • func (t *Templater) GenerateUpgradePreflightManifest(ctx context.Context, spec *cluster.Spec) ([]byte, error)
• type UpgradePlan
  • func BuildUpgradePlan(installation *Installation, clusterSpec *cluster.Spec) UpgradePlan
  • func (c UpgradePlan) Needed() bool
  • func (c UpgradePlan) Reason() string
• type Upgrader
  • func NewUpgrader(client Client, helm Helm) *Upgrader
  • func (u *Upgrader) RunPostControlPlaneUpgradeSetup(ctx context.Context, cluster *types.Cluster) error
  • func (u *Upgrader) Upgrade(ctx context.Context, cluster *types.Cluster, ...) (*types.ChangeDiff, error)

Constants

const (
	DaemonSetName           = "cilium"
	PreflightDaemonSetName  = "cilium-pre-flight-check"
	DeploymentName          = "cilium-operator"
	PreflightDeploymentName = "cilium-pre-flight-check"
)

Functions

func ChangeDiff

func ChangeDiff(currentSpec, newSpec *cluster.Spec) *types.ChangeDiff

func CheckDaemonSetReady

func CheckDaemonSetReady(daemonSet *v1.DaemonSet) error

func CheckDeploymentReady

func CheckDeploymentReady(deployment *v1.Deployment) error

func CheckPreflightDaemonSetReady

func CheckPreflightDaemonSetReady(ciliumDaemonSet, preflightDaemonSet *v1.DaemonSet) error

Types

type Cilium

type Cilium struct {
	*Upgrader
}

func NewCilium

func NewCilium(client Client, helm Helm) *Cilium

func (*Cilium) GenerateManifest

func (c *Cilium) GenerateManifest(ctx context.Context, clusterSpec *cluster.Spec, providerNamespaces []string) ([]byte, error)

type Client

type Client interface {
	ApplyKubeSpecFromBytes(ctx context.Context, cluster *types.Cluster, data []byte) error
	DeleteKubeSpecFromBytes(ctx context.Context, cluster *types.Cluster, data []byte) error
	GetDaemonSet(ctx context.Context, name, namespace, kubeconfig string) (*v1.DaemonSet, error)
	GetDeployment(ctx context.Context, name, namespace, kubeconfig string) (*v1.Deployment, error)
	RolloutRestartDaemonSet(ctx context.Context, name, namespace, kubeconfig string) error
}

type ComponentUpgradePlan

type ComponentUpgradePlan struct {
	UpgradeReason string
	OldImage      string
	NewImage      string
}

ComponentUpgradePlan contains upgrade information for a Cilium component

func (ComponentUpgradePlan) Needed

func (c ComponentUpgradePlan) Needed() bool

Needed determines if an upgrade is needed or not

type Helm

type Helm interface {
	Template(ctx context.Context, ociURI, version, namespace string, values interface{}, kubeVersion string) ([]byte, error)
}

type Installation

type Installation struct {
	DaemonSet *appsv1.DaemonSet
	Operator  *appsv1.Deployment
}

Installation represents the Cilium components installed in a cluster

func (Installation) Installed

func (i Installation) Installed() bool

Installed determines if all Cilium components are present

type ManifestConfig

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

type ManifestOpt

type ManifestOpt func(*ManifestConfig)

ManifestOpt allows to modify options for a cilium manifest

func WithKubeVersion

func WithKubeVersion(kubeVersion string) ManifestOpt

WithKubeVersion allows to generate the Cilium manifest for a different kubernetes version than the one specified in the cluster spec. Useful for upgrades scenarios where Cilium is upgraded before the kubernetes components

func WithPolicyAllowedNamespaces

func WithPolicyAllowedNamespaces(namespaces []string) ManifestOpt

WithPolicyAllowedNamespaces allows to specify which namespaces traffic should be allowed when using and "Always" policy enforcement mode

func WithRetrier

func WithRetrier(retrier *retrier.Retrier) ManifestOpt

WithRetrier introduced for optimizing unit tests

func WithUpgradeFromVersion

func WithUpgradeFromVersion(version semver.Version) ManifestOpt

WithUpgradeFromVersion allows to specify the compatibility Cilium version to use in the manifest. This is necessary for Cilium upgrades

type Templater

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

func NewTemplater

func NewTemplater(helm Helm) *Templater

func (*Templater) GenerateManifest

func (t *Templater) GenerateManifest(ctx context.Context, spec *cluster.Spec, opts ...ManifestOpt) ([]byte, error)

func (*Templater) GenerateNetworkPolicyManifest

func (t *Templater) GenerateNetworkPolicyManifest(spec *cluster.Spec, namespaces []string) ([]byte, error)

func (*Templater) GenerateUpgradePreflightManifest

func (t *Templater) GenerateUpgradePreflightManifest(ctx context.Context, spec *cluster.Spec) ([]byte, error)

type UpgradePlan

type UpgradePlan struct {
	DaemonSet ComponentUpgradePlan
	Operator  ComponentUpgradePlan
}

UpgradePlan contains information about a Cilium installation upgrade

func BuildUpgradePlan

func BuildUpgradePlan(installation *Installation, clusterSpec *cluster.Spec) UpgradePlan

BuildUpgradePlan generates the upgrade plan information for a cilium installation by comparing it with a desired cluster Spec

func (UpgradePlan) Needed

func (c UpgradePlan) Needed() bool

Needed determines if an upgrade is needed or not Returns true if any of the installation components needs an upgrade

func (UpgradePlan) Reason

func (c UpgradePlan) Reason() string

Reason returns the reason why an upgrade might be needed If no upgrade needed, returns empty string For multiple components with needed upgrades, it composes their reasons into one

type Upgrader

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

func NewUpgrader

func NewUpgrader(client Client, helm Helm) *Upgrader

func (*Upgrader) RunPostControlPlaneUpgradeSetup

func (u *Upgrader) RunPostControlPlaneUpgradeSetup(ctx context.Context, cluster *types.Cluster) error

func (*Upgrader) Upgrade

func (u *Upgrader) Upgrade(ctx context.Context, cluster *types.Cluster, currentSpec, newSpec *cluster.Spec, namespaces []string) (*types.ChangeDiff, error)