types

Documentation

Index

• type Clabernetes

Types

type Clabernetes

type Clabernetes interface {
	// GetContext returns the main/root context for the manager.
	GetContext() context.Context

	// GetContextCancel returns the cancel func for the main/root context for the manager.
	GetContextCancel() context.CancelFunc

	// GetAppName returns the "appName" for the clabernetes deployment, usually "clabernetes".
	GetAppName() string

	// GetBaseLogger returns the base/clabernetes claberneteslogging.Instance.
	GetBaseLogger() claberneteslogging.Instance

	// GetNamespace returns the namespace the clabernetes instance is running in.
	GetNamespace() string

	// GetClusterCRIKind returns the kind (from a clabernetes perspective) of the cluster CRI --
	// this value can be `containerd`, `crio` or `unknown`. If all nodes in a cluster (at the time
	// the manager starts up) are of a given CRI kind we make the (possibly not great) assumption
	// that the cluster is made up of only that CRI type. If there is a mix of CRIs we set the kind
	// to "unknown".
	GetClusterCRIKind() string

	// IsInitializer returns true if the clabernetes instance is an initializer instance -- if true
	// this means that this instance should update crds, webhook configurations, and other
	// initialization resources.
	IsInitializer() bool

	// GetKubeConfig returns the in-cluster rest.Config for the clabernetes instance.
	GetKubeConfig() *rest.Config

	// GetKubeClient returns the in-cluster kubernetes.Clientset for the clabernetes instance.
	GetKubeClient() *kubernetes.Clientset

	// GetKubeClabernetesClient returns the in-cluster clabernetes Clientset client.
	GetKubeClabernetesClient() *clabernetesgeneratedclientset.Clientset

	// GetCtrlRuntimeMgr returns the controller-runtime Manager for the clabernetes instance.
	GetCtrlRuntimeMgr() ctrlruntime.Manager

	// GetScheme returns apimachineryruntime.Scheme in use by the manager.
	GetScheme() *apimachineryruntime.Scheme

	// GetCtrlRuntimeClient returns the controller-runtime client.
	GetCtrlRuntimeClient() ctrlruntimeclient.Client

	// NewContextWithTimeout returns a new context and its cancelFunc from the base clabernetes
	// context.
	NewContextWithTimeout() (context.Context, context.CancelFunc)

	// IsReady returns the readiness state of the manager.
	IsReady() bool

	// Exit flushes the logging manager and exits with the given exit code.
	Exit(exitCode int)
}

Clabernetes is an interface that defines the publicly available methods of the manager object.