utils

Documentation

Overview

This file contains functions common to the controllers to help them interact with elasticsearch.

Index

• Variables
• func AddAPIServerWatch(c controller.Controller) error
• func AddComplianceWatch(c controller.Controller) error
• func AddConfigMapWatch(c controller.Controller, name, namespace string) error
• func AddNetworkWatch(c controller.Controller) error
• func AddSecretsWatch(c controller.Controller, name, namespace string, metaMatches ...MetaMatch) error
• func AddServiceWatch(c controller.Controller, name, namespace string) error
• func AutoDiscoverProvider(cfg *rest.Config) (operatorv1.Provider, error)
• func CheckLicenseKey(ctx context.Context, cli client.Client) error
• func ContextLoggerForResource(log logr.Logger, obj runtime.Object) logr.Logger
• func ElasticsearchSecrets(ctx context.Context, userSecretNames []string, cli client.Client) ([]*corev1.Secret, error)
• func GetElasticsearchClusterConfig(ctx context.Context, cli client.Client) (*render.ElasticsearchClusterConfig, error)
• func GetNetworkingPullSecrets(i *operatorv1.Installation, c client.Client) ([]*corev1.Secret, error)
• func IgnoreObject(obj runtime.Object) bool
• func IsAPIServerReady(client client.Client, l logr.Logger) bool
• func IsLogStorageReady(ctx context.Context, cli client.Client) (bool, error)
• func RandomPassword(length int) (string, error)
• func RequiresTigeraSecure(cfg *rest.Config) (bool, error)
• func ValidateCertPair(client client.Client, certPairSecretName, keyName, certName string) (*corev1.Secret, error)
• type ComponentHandler
  • func NewComponentHandler(log logr.Logger, client client.Client, scheme *runtime.Scheme, ...) ComponentHandler
• type MetaMatch

Variables

var DefaultInstanceKey = client.ObjectKey{Name: "default"}

var DefaultTSEEInstanceKey = client.ObjectKey{Name: "tigera-secure"}

Functions

func AddAPIServerWatch

func AddAPIServerWatch(c controller.Controller) error

func AddComplianceWatch

func AddComplianceWatch(c controller.Controller) error

func AddConfigMapWatch

func AddConfigMapWatch(c controller.Controller, name, namespace string) error

func AddNetworkWatch

func AddNetworkWatch(c controller.Controller) error

func AddSecretsWatch

func AddSecretsWatch(c controller.Controller, name, namespace string, metaMatches ...MetaMatch) error

func AddServiceWatch

func AddServiceWatch(c controller.Controller, name, namespace string) error

func AutoDiscoverProvider

func AutoDiscoverProvider(cfg *rest.Config) (operatorv1.Provider, error)

func CheckLicenseKey

func CheckLicenseKey(ctx context.Context, cli client.Client) error

CheckLicenseKey checks if a license has been installed. It's useful to prevent rollout of TSEE components that might require it. It will return an error if the license is not installed, and nil otherwise.

func ContextLoggerForResource

func ContextLoggerForResource(log logr.Logger, obj runtime.Object) logr.Logger

ContextLoggerForResource provides a logger instance with context set for the provided object.

func ElasticsearchSecrets

func ElasticsearchSecrets(ctx context.Context, userSecretNames []string, cli client.Client) ([]*corev1.Secret, error)

ElasticsearchSecrets gets the secrets needed for a component to be able to access Elasticsearch

func GetElasticsearchClusterConfig

func GetElasticsearchClusterConfig(ctx context.Context, cli client.Client) (*render.ElasticsearchClusterConfig, error)

GetElasticsearchClusterConfig retrieves the config map containing the elasticsearch configuration values, such as the the cluster name and replica count.

func GetNetworkingPullSecrets

func GetNetworkingPullSecrets(i *operatorv1.Installation, c client.Client) ([]*corev1.Secret, error)

func IgnoreObject

func IgnoreObject(obj runtime.Object) bool

IgnoreObject returns true if the object has been marked as ignored by the user, and returns false otherwise.

func IsAPIServerReady

func IsAPIServerReady(client client.Client, l logr.Logger) bool

func IsLogStorageReady

func IsLogStorageReady(ctx context.Context, cli client.Client) (bool, error)

func RandomPassword

func RandomPassword(length int) (string, error)

func RequiresTigeraSecure

func RequiresTigeraSecure(cfg *rest.Config) (bool, error)

RequiresTigeraSecure determines if the configuration requires we start the tigera secure controllers.

func ValidateCertPair

func ValidateCertPair(client client.Client, certPairSecretName, keyName, certName string) (*corev1.Secret, error)

ValidateCertPair checks if the given secret exists and if so that it contains key and cert fields. If a secret exists then it is returned. If there is an error accessing the secret (except NotFound) or the cert does not have both a key and cert field then an appropriate error is returned. If no secret exists then nil, nil is returned to represent that no cert is valid.

Types

type ComponentHandler

type ComponentHandler interface {
	CreateOrUpdate(context.Context, render.Component, *status.StatusManager) error
}

func NewComponentHandler

func NewComponentHandler(log logr.Logger, client client.Client, scheme *runtime.Scheme, cr metav1.Object) ComponentHandler

type MetaMatch

type MetaMatch func(metav1.ObjectMeta) bool