utils

Documentation

Overview

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

Index

• Constants
• Variables
• func AddAPIServerWatch(c controller.Controller) error
• func AddComplianceWatch(c controller.Controller) error
• func AddConfigMapWatch(c controller.Controller, name, namespace string) error
• func AddNamespaceWatch(c controller.Controller, name 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(ctx context.Context, clientset kubernetes.Interface) (operatorv1.Provider, error)
• func CheckLicenseKey(ctx context.Context, cli client.Client) error
• func ContextLoggerForResource(log logr.Logger, obj client.Object) logr.Logger
• func ElasticsearchSecrets(ctx context.Context, userSecretNames []string, cli client.Client) ([]*corev1.Secret, error)
• func EnsureCertificateSecret(secretName string, secret *corev1.Secret, keyName string, certName string, ...) (*corev1.Secret, error)
• func GetAmazonCloudIntegration(ctx context.Context, client client.Client) (*operatorv1.AmazonCloudIntegration, error)
• func GetAuthentication(ctx context.Context, cli client.Client) (*operatorv1.Authentication, error)
• func GetElasticLicenseType(ctx context.Context, cli client.Client, logger logr.Logger) (render.ElasticsearchLicenseType, error)
• func GetElasticsearchClusterConfig(ctx context.Context, cli client.Client) (*render.ElasticsearchClusterConfig, error)
• func GetManagementCluster(ctx context.Context, c client.Client) (*operatorv1.ManagementCluster, error)
• func GetManagementClusterConnection(ctx context.Context, c client.Client) (*operatorv1.ManagementClusterConnection, error)
• func GetNetworkingPullSecrets(i *operatorv1.InstallationSpec, c client.Client) ([]*corev1.Secret, error)
• func GetSecret(ctx context.Context, client client.Client, name string, ns string) (*corev1.Secret, error)
• func IgnoreObject(obj runtime.Object) bool
• func IsAPIServerReady(client client.Client, l logr.Logger) bool
• func IsOperatorManaged(certSecret *corev1.Secret, certKeyName string) (bool, error)
• func LogStorageExists(ctx context.Context, cli client.Client) (bool, error)
• func RandomPassword(length int) (string, error)
• func RequiresAmazonController(cfg *rest.Config) (bool, error)
• func RequiresTigeraSecure(cfg *rest.Config) (bool, error)
• func SecretHasExpectedDNSNames(secret *corev1.Secret, certKeyName string, expectedDNSNames []string) error
• func StrToElasticLicenseType(license string, logger logr.Logger) render.ElasticsearchLicenseType
• func ValidateCertPair(client client.Client, namespace, certPairSecretName, keyName, certName string) (*corev1.Secret, error)
• type ComponentHandler
  • func NewComponentHandler(log logr.Logger, client client.Client, scheme *runtime.Scheme, ...) ComponentHandler
• type ElasticClient
  • func NewElasticClient() ElasticClient
• type MetaMatch
• type Policy

Constants

const (
	ElasticsearchRetentionFactor = 4
	DefaultMaxIndexSizeGi        = 30
	ElasticConnRetries           = 10
	ElasticConnRetryInterval     = "500ms"
)

Variables

var (
	ErrInvalidCertDNSNames  = errors.New("cert has the wrong DNS names")
	ErrInvalidCertNoPEMData = errors.New("cert has no PEM data")
)

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

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

var OverlayInstanceKey = client.ObjectKey{Name: "overlay"}

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 AddNamespaceWatch

func AddNamespaceWatch(c controller.Controller, name 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(ctx context.Context, clientset kubernetes.Interface) (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 client.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 EnsureCertificateSecret

func EnsureCertificateSecret(secretName string, secret *corev1.Secret, keyName string, certName string, certDuration time.Duration, svcDNSNames ...string) (*corev1.Secret, error)

EnsureCertificateSecret ensures that the certificate in the secret has the expected DNS names. If no secret is provided, a new secret is created and returned. If the secret does have the right DNS names then the secret is returned. If the cert in the secret has invalid DNS names and the secret is operator managed, then a new secret is created and returned. Otherwise, if the secret is user-supplied, an error is returned.

func GetAmazonCloudIntegration

func GetAmazonCloudIntegration(ctx context.Context, client client.Client) (*operatorv1.AmazonCloudIntegration, error)

GetAmazonCloudIntegration returns the tigera AmazonCloudIntegration instance.

func GetAuthentication

func GetAuthentication(ctx context.Context, cli client.Client) (*operatorv1.Authentication, error)

GetAuthentication finds the authentication CR in your cluster.

func GetElasticLicenseType

func GetElasticLicenseType(ctx context.Context, cli client.Client, logger logr.Logger) (render.ElasticsearchLicenseType, error)

GetElasticLicenseType returns the license type from elastic-licensing ConfigMap that ECK operator keeps updated.

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 GetManagementCluster

func GetManagementCluster(ctx context.Context, c client.Client) (*operatorv1.ManagementCluster, error)

Return the ManagementCluster CR if present. No error is returned if it was not found.

func GetManagementClusterConnection

func GetManagementClusterConnection(ctx context.Context, c client.Client) (*operatorv1.ManagementClusterConnection, error)

Return the ManagementClusterConnection CR if present. No error is returned if it was not found.

func GetNetworkingPullSecrets

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

func GetSecret

func GetSecret(ctx context.Context, client client.Client, name string, ns string) (*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 IsOperatorManaged

func IsOperatorManaged(certSecret *corev1.Secret, certKeyName string) (bool, error)

Check if the cert secret is created and managed by the operator.

func LogStorageExists

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

func RandomPassword

func RandomPassword(length int) (string, error)

func RequiresAmazonController

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

RequiresAmazonController determines if the configuration requires we start the aws controllers.

func RequiresTigeraSecure

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

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

func SecretHasExpectedDNSNames

func SecretHasExpectedDNSNames(secret *corev1.Secret, certKeyName string, expectedDNSNames []string) error

Check that the cert in the secret has the expected DNS names.

func StrToElasticLicenseType

func StrToElasticLicenseType(license string, logger logr.Logger) render.ElasticsearchLicenseType

StrToElasticLicenseType maps Elasticsearch license to one of the known and expected value.

func ValidateCertPair

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

ValidateCertPairInNamespace checks if the given secret exists in the given namespace 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 ElasticClient

type ElasticClient interface {
	SetILMPolicies(client.Client, context.Context, *operatorv1.LogStorage, string) error
}

func NewElasticClient

func NewElasticClient() ElasticClient

type MetaMatch

type MetaMatch func(metav1.ObjectMeta) bool

type Policy

type Policy struct {
	Phases struct {
		Hot struct {
			Actions struct {
				Rollover struct {
					MaxSize string `json:"max_size"`
					MaxAge  string `json:"max_age"`
				}
			}
		}
		Delete struct {
			MinAge string `json:"min_age"`
		}
	}
}