controllers

Documentation

Index

• Constants
• func NewDeploymentReconciler(client client.Client, updater IngressUpdater) *deploymentReconciler
• func NewIngressClassCreator(client client.Client, className string, namespace string, ...) *ingressClassCreator
• func NewIngressUpdater(client client.Client, globalConfigRepo GlobalConfigRepository, ...) (*ingressUpdater, error)
• func NewMaintenanceModeUpdater(client k8sClient, namespace string, ingressUpdater IngressUpdater, ...) (*maintenanceModeUpdater, error)
• func NewSelfsignedCertificateUpdater(client client.Client, namespace string, ...) *selfsignedCertificateUpdater
• func NewServiceReconciler(client client.Client, updater IngressUpdater) *serviceReconciler
• func NewSslCertificateUpdater(client client.Client, namespace string, ...) *sslCertificateUpdater
• func NewWarpMenuCreator(client client.Client, doguVersionRegistry warp.DoguVersionRegistry, ...) *warpMenuCreator
• type CesService
• type DeploymentReadyChecker
• type GlobalConfigRepository
• type IngressUpdater

Constants

const CesServiceAnnotation = "k8s-dogu-operator.cloudogu.com/ces-services"

CesServiceAnnotation can be appended to service with information of ces services.

Functions

func NewDeploymentReconciler

func NewDeploymentReconciler(client client.Client, updater IngressUpdater) *deploymentReconciler

NewDeploymentReconciler creates a new deployment reconciler.

func NewIngressClassCreator

func NewIngressClassCreator(client client.Client, className string, namespace string, recorder eventRecorder) *ingressClassCreator

NewIngressClassCreator creates a new ingress class creator.

func NewIngressUpdater

func NewIngressUpdater(client client.Client, globalConfigRepo GlobalConfigRepository, namespace string, ingressClassName string, recorder eventRecorder) (*ingressUpdater, error)

NewIngressUpdater creates a new instance responsible for updating ingress objects.

func NewMaintenanceModeUpdater

func NewMaintenanceModeUpdater(client k8sClient, namespace string, ingressUpdater IngressUpdater, recorder eventRecorder, globalConfigRepo GlobalConfigRepository) (*maintenanceModeUpdater, error)

NewMaintenanceModeUpdater creates a new maintenance mode updater.

func NewSelfsignedCertificateUpdater

func NewSelfsignedCertificateUpdater(client client.Client, namespace string, globalConfigRepo GlobalConfigRepository, recorder eventRecorder) *selfsignedCertificateUpdater

NewSelfsignedCertificateUpdater creates a new updater.

func NewServiceReconciler

func NewServiceReconciler(client client.Client, updater IngressUpdater) *serviceReconciler

NewServiceReconciler creates a new service reconciler.

func NewSslCertificateUpdater

func NewSslCertificateUpdater(client client.Client, namespace string, globalConfigRepo GlobalConfigRepository, recorder eventRecorder) *sslCertificateUpdater

NewSslCertificateUpdater creates a new updater.

func NewWarpMenuCreator

func NewWarpMenuCreator(client client.Client, doguVersionRegistry warp.DoguVersionRegistry, localDoguRepo warp.LocalDoguRepo, namespace string, recorder eventRecorder, globalConfig warp.GlobalConfigRepository) *warpMenuCreator

NewWarpMenuCreator initialises a creator object to start the warp menu creation

Types

type CesService

type CesService struct {
	// Name of the ces service serving as identifier.
	Name string `json:"name"`
	// Port of the ces service.
	Port int `json:"port"`
	// Location of the ces service defining the external path to the service.
	Location string `json:"location"`
	// Pass of the ces service defining the target path inside the service's pod.
	Pass string `json:"pass"`
	// Rewrite that should be applied to the ingress configuration.
	// Is a json-marshalled `serviceRewrite`. Useful if Dogus do not support sub-paths.
	Rewrite string `json:"rewrite,omitempty"`
}

CesService contains information about one exposed ces service.

type DeploymentReadyChecker

type DeploymentReadyChecker interface {
	// IsReady checks whether the application of the deployment is ready, i.e., contains at least one ready pod.
	IsReady(ctx context.Context, deploymentName string) (bool, error)
}

DeploymentReadyChecker checks the readiness from deployments.

type GlobalConfigRepository

type GlobalConfigRepository interface {
	Get(context.Context) (libconfig.GlobalConfig, error)
	Watch(context.Context, ...libconfig.WatchFilter) (<-chan repository.GlobalConfigWatchResult, error)
	Update(ctx context.Context, globalConfig libconfig.GlobalConfig) (libconfig.GlobalConfig, error)
}

type IngressUpdater

type IngressUpdater interface {
	// UpsertIngressForService creates or updates the ingress object of the given service.
	UpsertIngressForService(ctx context.Context, service *corev1.Service) error
}

IngressUpdater is responsible to create and update the actual ingress objects in the cluster.