utils

Documentation

Overview

Package utils contains shared utility methods for the Liqonet package.

Index

• Constants
• func AddRemoteNamespaceCondition(conditions *[]offv1alpha1.RemoteNamespaceCondition, ...)
• func FindRemoteNamespaceCondition(conditions []offv1alpha1.RemoteNamespaceCondition, ...) *offv1alpha1.RemoteNamespaceCondition
• func FromResult(result controllerutil.OperationResult) klog.Level
• func GetAPIServerAddressFromMasterNode(ctx context.Context, clientset kubernetes.Interface) (address string, err error)
• func GetAPIServerURL(apiServerConfigProvider ApiServerConfigProvider, ...) (string, error)
• func GetClusterIDFromNodeName(nodeName string) string
• func GetClusterIDWithControllerClient(ctx context.Context, controllerClient client.Client, namespace string) (string, error)
• func GetClusterIDWithNativeClient(ctx context.Context, nativeClient kubernetes.Interface, namespace string) (string, error)
• func GetOwnerByKind(ownerReferences *[]v1.OwnerReference, kind string) *v1.OwnerReference
• func GetRestConfig(configPath string) (config *rest.Config, err error)
• func IsNodeReady(node *corev1.Node) bool
• func IsStatusConditionFalse(conditions []offv1alpha1.RemoteNamespaceCondition, ...) bool
• func IsStatusConditionPresentAndEqual(conditions []offv1alpha1.RemoteNamespaceCondition, ...) bool
• func IsStatusConditionTrue(conditions []offv1alpha1.RemoteNamespaceCondition, ...) bool
• func MergeMaps(m1, m2 map[string]string) map[string]string
• func RemoveRemoteNamespaceCondition(conditions *[]offv1alpha1.RemoteNamespaceCondition, ...)
• func RetrieveNamespace() (string, error)
• func SubMaps(m1, m2 map[string]string) map[string]string
• func UserConfig(configPath string) (*rest.Config, error)
• func WatchConfiguration(handler func(*configv1alpha1.ClusterConfig), client *crdclient.CRDClient, ...)
• func WriteFile(filepath string, content []byte) error
• type ApiServerConfigProvider

Constants

const (
	// LogInfoLevel -> level associated with informational messages.
	LogInfoLevel = 0
	// LogDebugLevel -> level associated with debug messages.
	LogDebugLevel = 4
)

Functions

func AddRemoteNamespaceCondition

func AddRemoteNamespaceCondition(conditions *[]offv1alpha1.RemoteNamespaceCondition,
	newCondition *offv1alpha1.RemoteNamespaceCondition)

AddRemoteNamespaceCondition sets newCondition in the conditions slice. conditions must be non-nil.

1. if the condition of the specified type already exists (all fields of the existing condition are updated to newCondition, LastTransitionTime is set to now if the new status differs from the old status).
2. if a condition of the specified type does not exist (LastTransitionTime is set to now() if unset, and newCondition is appended).

func FindRemoteNamespaceCondition

func FindRemoteNamespaceCondition(conditions []offv1alpha1.RemoteNamespaceCondition,
	conditionType offv1alpha1.RemoteNamespaceConditionType) *offv1alpha1.RemoteNamespaceCondition

FindRemoteNamespaceCondition finds the conditionType in conditions.

func FromResult

func FromResult(result controllerutil.OperationResult) klog.Level

FromResult returns a logger level, given the result of a CreateOrUpdate operation.

func GetAPIServerAddressFromMasterNode

func GetAPIServerAddressFromMasterNode(ctx context.Context,
	clientset kubernetes.Interface) (address string, err error)

GetAPIServerAddressFromMasterNode returns the API Server address using the IP of the master node of this cluster. The port is always defaulted to 6443.

func GetAPIServerURL

func GetAPIServerURL(apiServerConfigProvider ApiServerConfigProvider, clientset kubernetes.Interface) (string, error)

GetAPIServerURL retrieves the API server URL either from the configuration or selecting the IP address of a master node (with port 6443).

func GetClusterIDFromNodeName

func GetClusterIDFromNodeName(nodeName string) string

GetClusterIDFromNodeName returns the clusterID from a node name.

func GetClusterIDWithControllerClient

func GetClusterIDWithControllerClient(ctx context.Context, controllerClient client.Client, namespace string) (string, error)

GetClusterIDWithControllerClient returns clusterID using a client.Client client.

func GetClusterIDWithNativeClient

func GetClusterIDWithNativeClient(ctx context.Context, nativeClient kubernetes.Interface, namespace string) (string, error)

GetClusterIDWithNativeClient returns clusterID using a kubernetes.Interface client.

func GetOwnerByKind

func GetOwnerByKind(ownerReferences *[]v1.OwnerReference, kind string) *v1.OwnerReference

func GetRestConfig

func GetRestConfig(configPath string) (config *rest.Config, err error)

GetRestConfig returns a rest.Config object to initialize a client to the target cluster.

func IsNodeReady

func IsNodeReady(node *corev1.Node) bool

IsNodeReady returns true if the passed node has the NodeReady condition = True, false otherwise.

func IsStatusConditionFalse

func IsStatusConditionFalse(conditions []offv1alpha1.RemoteNamespaceCondition,
	conditionType offv1alpha1.RemoteNamespaceConditionType) bool

IsStatusConditionFalse returns true when the conditionType is present and set to `corev1.ConditionFalse`.

func IsStatusConditionPresentAndEqual

func IsStatusConditionPresentAndEqual(conditions []offv1alpha1.RemoteNamespaceCondition,
	conditionType offv1alpha1.RemoteNamespaceConditionType, status corev1.ConditionStatus) bool

IsStatusConditionPresentAndEqual returns true when conditionType is present and equal to status.

func IsStatusConditionTrue

func IsStatusConditionTrue(conditions []offv1alpha1.RemoteNamespaceCondition,
	conditionType offv1alpha1.RemoteNamespaceConditionType) bool

IsStatusConditionTrue returns true when the conditionType is present and set to `corev1.ConditionTrue`.

func MergeMaps

func MergeMaps(m1, m2 map[string]string) map[string]string

MergeMaps merges two maps.

func RemoveRemoteNamespaceCondition

func RemoveRemoteNamespaceCondition(conditions *[]offv1alpha1.RemoteNamespaceCondition,
	conditionType offv1alpha1.RemoteNamespaceConditionType)

RemoveRemoteNamespaceCondition removes the corresponding conditionType from conditions. conditions must be non-nil.

func RetrieveNamespace

func RetrieveNamespace() (string, error)

RetrieveNamespace tries to retrieve the name of the namespace where the process is executed. It tries to get the namespace: - Firstly, using the POD_NAMESPACE variable - Secondly, by looking for the namespace value contained in a mounted ServiceAccount (if any) Otherwise, it returns an empty string and an error.

func SubMaps

func SubMaps(m1, m2 map[string]string) map[string]string

SubMaps removes elements of m2 from m1.

func UserConfig

func UserConfig(configPath string) (*rest.Config, error)

func WatchConfiguration

func WatchConfiguration(handler func(*configv1alpha1.ClusterConfig), client *crdclient.CRDClient, kubeconfigPath string)

WatchConfiguration watches the ClusterConfig CR, and calls the handler funcition on updates.

func WriteFile

func WriteFile(filepath string, content []byte) error

Types

type ApiServerConfigProvider

type ApiServerConfigProvider interface {
	GetAPIServerConfig() *configv1alpha1.APIServerConfig
}