util

Documentation

Index

• Constants
• Variables
• func AreStringSlicesIdentical(a, b []string) bool
• func BoolPointer(b bool) *bool
• func ConstructEListenerLabelName(ingressConfigName, eListenerName string) string
• func ConvertConfigEntryListToProperties(config []sarama.ConfigEntry) (*properties.Properties, error)
• func ConvertPropertiesToMapStringPointer(pp *properties.Properties) map[string]*string
• func ConvertStringToInt32(s string) int32
• func CreateLogger(debug bool, development bool) logr.Logger
• func CreateTLSConfigFromSecret(tlsKeys *corev1.Secret) (*tls.Config, error)
• func GenerateEnvoyResourceName(resourceNameFormat string, resourceNameWithScopeFormat string, ...) string
• func GetBrokerFromBrokerConfigurationBackup(config string) (v1beta1.Broker, error)
• func GetBrokerIdsFromStatusAndSpec(brokerStatuses map[string]v1beta1.BrokerState, brokers []v1beta1.Broker, ...) []int
• func GetBrokerImage(brokerConfig *v1beta1.BrokerConfig, clusterImage string) string
• func GetBrokerMetricsReporterImage(brokerConfig *v1beta1.BrokerConfig, kafkaClusterSpec v1beta1.KafkaClusterSpec) string
• func GetClientTLSConfig(client clientCtrl.Reader, secretNamespaceName types.NamespacedName) (*tls.Config, error)
• func GetExternalPortForBroker(externalStartingPort, brokerId int32) int32
• func GetIngressConfigs(kafkaClusterSpec v1beta1.KafkaClusterSpec, ...) (map[string]v1beta1.IngressConfig, string, error)
• func GetRandomString(length int) (string, error)
• func GzipAndBase64BrokerConfiguration(broker *v1beta1.Broker) (string, error)
• func Int32Pointer(i int32) *int32
• func Int64Pointer(i int64) *int64
• func IntPointer(i int) *int
• func IntstrPointer(i int) *intstr.IntOrString
• func IsIngressConfigInUse(iConfigName, defaultConfigName string, cluster *v1beta1.KafkaCluster, ...) bool
• func IsSSLEnabledForInternalCommunication(l []v1beta1.InternalListenerConfig) (enabled bool)
• func MapStringStringPointer(in map[string]string) (out map[string]*string)
• func Max(x, y int) int
• func MergeAnnotations(annotations ...map[string]string) map[string]string
• func ObjectManagedByClusterRegistry(object metav1.Object) bool
• func QuantityPointer(q resource.Quantity) *resource.Quantity
• func RetryOnConflict(backoff wait.Backoff, fn func() error) error
• func RetryOnError(backoff wait.Backoff, fn func() error, isRetryableError func(error) bool) error
• func ShouldIncludeBroker(brokerConfig *v1beta1.BrokerConfig, status v1beta1.KafkaClusterStatus, ...) bool
• func StorageConfigKafkaMountPath(mountPath string) string
• func StringPointer(s string) *string
• func StringSliceContains(list []string, s string) bool
• func StringSliceRemove(list []string, s string) []string

Constants

const (
	IngressConfigGlobalName           = "globalConfig"
	ExternalListenerLabelNameTemplate = "%s-%s"
	ExternalListenerLabelNameKey      = "eListenerName"
)

Variables

var DefaultBackOffForConflict wait.Backoff = wait.Backoff{
	Duration: 20 * time.Millisecond,
	Jitter:   0,
	Factor:   2.5,
	Steps:    6,
}

start with 20 ms, multiply by 2.5 each step, 6 steps = ~3 seconds

Functions

func AreStringSlicesIdentical

func AreStringSlicesIdentical(a, b []string) bool

func BoolPointer

func BoolPointer(b bool) *bool

BoolPointer generates bool pointer from bool

func ConstructEListenerLabelName

func ConstructEListenerLabelName(ingressConfigName, eListenerName string) string

ConstructEListenerLabelName construct an eListener label name based on ingress config name and listener name

func ConvertConfigEntryListToProperties

func ConvertConfigEntryListToProperties(config []sarama.ConfigEntry) (*properties.Properties, error)

ConvertConfigEntryListToProperties function takes []sarama.ConfigEntry and coverts it to Properties object

func ConvertPropertiesToMapStringPointer

func ConvertPropertiesToMapStringPointer(pp *properties.Properties) map[string]*string

ConvertPropertiesToMapStringPointer converts a Properties object to map[string]*string

func ConvertStringToInt32

func ConvertStringToInt32(s string) int32

ConvertStringToInt32 converts the given string to int32

func CreateLogger

func CreateLogger(debug bool, development bool) logr.Logger

func CreateTLSConfigFromSecret

func CreateTLSConfigFromSecret(tlsKeys *corev1.Secret) (*tls.Config, error)

func GenerateEnvoyResourceName

func GenerateEnvoyResourceName(resourceNameFormat string, resourceNameWithScopeFormat string, extListener v1beta1.ExternalListenerConfig, ingressConfig v1beta1.IngressConfig,
	ingressConfigName, clusterName string) string

func GetBrokerFromBrokerConfigurationBackup

func GetBrokerFromBrokerConfigurationBackup(config string) (v1beta1.Broker, error)

func GetBrokerIdsFromStatusAndSpec

func GetBrokerIdsFromStatusAndSpec(brokerStatuses map[string]v1beta1.BrokerState, brokers []v1beta1.Broker, log logr.Logger) []int

returns the union of the ids of the configured (Spec.Brokers) and the running (BrokerState) brokers

func GetBrokerImage

func GetBrokerImage(brokerConfig *v1beta1.BrokerConfig, clusterImage string) string

GetBrokerImage returns the used broker image

func GetBrokerMetricsReporterImage

func GetBrokerMetricsReporterImage(brokerConfig *v1beta1.BrokerConfig, kafkaClusterSpec v1beta1.KafkaClusterSpec) string

GetBrokerMetricsReporterImage returns the image used for cruise-control metrics reporter

func GetClientTLSConfig

func GetClientTLSConfig(client clientCtrl.Reader, secretNamespaceName types.NamespacedName) (*tls.Config, error)

func GetExternalPortForBroker

func GetExternalPortForBroker(externalStartingPort, brokerId int32) int32

func GetIngressConfigs

func GetIngressConfigs(kafkaClusterSpec v1beta1.KafkaClusterSpec,
	eListenerConfig v1beta1.ExternalListenerConfig) (map[string]v1beta1.IngressConfig, string, error)

GetIngressConfigs compose the ingress configuration for a given externalListener

func GetRandomString

func GetRandomString(length int) (string, error)

getRandomString returns a random string containing uppercase, lowercase and number characters with the length given

func GzipAndBase64BrokerConfiguration

func GzipAndBase64BrokerConfiguration(broker *v1beta1.Broker) (string, error)

func Int32Pointer

func Int32Pointer(i int32) *int32

Int32Pointer generates int32 pointer from int32

func Int64Pointer

func Int64Pointer(i int64) *int64

Int64Pointer generates int64 pointer from int64

func IntPointer

func IntPointer(i int) *int

IntPointer generates int pointer from int

func IntstrPointer

func IntstrPointer(i int) *intstr.IntOrString

IntstrPointer generate IntOrString pointer from int

func IsIngressConfigInUse

func IsIngressConfigInUse(iConfigName, defaultConfigName string, cluster *v1beta1.KafkaCluster, log logr.Logger) bool

IsIngressConfigInUse returns true if the provided ingressConfigName is bound to the given broker

func IsSSLEnabledForInternalCommunication

func IsSSLEnabledForInternalCommunication(l []v1beta1.InternalListenerConfig) (enabled bool)

IsSSLEnabledForInternalCommunication checks if ssl is enabled for internal communication

func MapStringStringPointer

func MapStringStringPointer(in map[string]string) (out map[string]*string)

MapStringStringPointer generates a map[string]*string

func Max

func Max(x, y int) int

computes the max between 2 ints

func MergeAnnotations

func MergeAnnotations(annotations ...map[string]string) map[string]string

func ObjectManagedByClusterRegistry

func ObjectManagedByClusterRegistry(object metav1.Object) bool

func QuantityPointer

func QuantityPointer(q resource.Quantity) *resource.Quantity

QuantityPointer generates Quantity pointer from Quantity

func RetryOnConflict

func RetryOnConflict(backoff wait.Backoff, fn func() error) error

func RetryOnError

func RetryOnError(backoff wait.Backoff, fn func() error, isRetryableError func(error) bool) error

func ShouldIncludeBroker

func ShouldIncludeBroker(brokerConfig *v1beta1.BrokerConfig, status v1beta1.KafkaClusterStatus, brokerID int,
	defaultIngressConfigName, ingressConfigName string) bool

ShouldIncludeBroker returns true if the broker should be included as a resource on external listener resources

func StorageConfigKafkaMountPath

func StorageConfigKafkaMountPath(mountPath string) string

func StringPointer

func StringPointer(s string) *string

StringPointer generates string pointer from string

func StringSliceContains

func StringSliceContains(list []string, s string) bool

StringSliceContains returns true if list contains s

func StringSliceRemove

func StringSliceRemove(list []string, s string) []string

StringSliceRemove will remove s from list