utils

Documentation

Overview

Package utils implements the util functions

Index

• Constants
• func CalculateSecretKeyMd5(secret *corev1.Secret, key string) (string, error)
• func ConvertJSONToMapStringInterface(raw *apiextensionsv1.JSON) (map[string]interface{}, error)
• func ConvertMap(input map[string]string) map[string]interface{}
• func CreateOrUpdatePrivateKeySecret(ctx context.Context, c client.Client, owner metav1.Object, ...) error
• func CreateOrUpdateServiceAccountCredentialsSecret(ctx context.Context, c client.Client, owner metav1.Object, ...) error
• func CreateOrUpdateTokenSecret(ctx context.Context, c client.Client, owner metav1.Object, ...) error
• func GetPrivateKeyFromSecret(ctx context.Context, c client.Client, namespace, name string) (string, error)
• func IsManaged(object metav1.Object) bool
• type ClientCredentials
• type Duration
  • func (d *Duration) Parse() (time.Duration, error)
• type Event
• type EventSource
  • func NewEventSource(log logr.Logger) *EventSource
  • func (s *EventSource) Close()
  • func (s *EventSource) Contains(key string) bool
  • func (s *EventSource) CreateIfAbsent(delay time.Duration, obj client.Object, key string)
  • func (s *EventSource) Remove(key string)
  • func (s *EventSource) Update(key string, delay time.Duration)
• type ReconcileRetryer
  • func NewReconcileRetryer(maxRetries int, source *EventSource) *ReconcileRetryer
  • func (r *ReconcileRetryer) Close()
  • func (r *ReconcileRetryer) Contains(obj client.Object) bool
  • func (r *ReconcileRetryer) CreateIfAbsent(obj client.Object)
  • func (r *ReconcileRetryer) Remove(obj client.Object)
  • func (r *ReconcileRetryer) Source() <-chan event.GenericEvent

Constants

const (
	// PrivateKeySecretSuffix is the suffix for private key secrets
	PrivateKeySecretSuffix = "-private-key"
	// TokenSecretSuffix is the suffix for token secrets
	TokenSecretSuffix = "-token"
	// PrivateKeyField is the key for the private key in the secret
	PrivateKeyField = "private-key"
	// TokenField is the key for the token in the secret
	TokenField = "token"
	// ServiceAccountCredentialsSecretSuffix is the suffix for service account credentials secrets
	ServiceAccountCredentialsSecretSuffix = "-credentials"
	// ServiceAccountCredentialsField is the key for the service account credentials in the secret
	ServiceAccountCredentialsField = "credentials.json"
	// ServiceAccountCredentialsType is the type for service account credentials
	//nolint:gosec
	ServiceAccountCredentialsType = "TYPE_SN_CREDENTIALS_FILE"
)

const (
	// ManagedAnnotation indicates the object is managed by the controller
	ManagedAnnotation = "cloud.streamnative.io/managed"
)

Functions

func CalculateSecretKeyMd5

func CalculateSecretKeyMd5(secret *corev1.Secret, key string) (string, error)

CalculateSecretKeyMd5 calculates the hash of the secret key.

func ConvertJSONToMapStringInterface

func ConvertJSONToMapStringInterface(raw *apiextensionsv1.JSON) (map[string]interface{}, error)

ConvertJSONToMapStringInterface converts a JSON object to a map[string]interface{}

func ConvertMap

func ConvertMap(input map[string]string) map[string]interface{}

ConvertMap converts a map[string]string to a map[string]interface{}

func CreateOrUpdatePrivateKeySecret

func CreateOrUpdatePrivateKeySecret(ctx context.Context, c client.Client, owner metav1.Object, namespace, name, privateKey string) error

CreateOrUpdatePrivateKeySecret creates or updates a secret containing a private key

func CreateOrUpdateServiceAccountCredentialsSecret

func CreateOrUpdateServiceAccountCredentialsSecret(ctx context.Context, c client.Client, owner metav1.Object, namespace, name, credentials string) error

CreateOrUpdateServiceAccountCredentialsSecret creates or updates a secret containing service account credentials

func CreateOrUpdateTokenSecret

func CreateOrUpdateTokenSecret(ctx context.Context, c client.Client, owner metav1.Object, namespace, name, token, keyID string) error

CreateOrUpdateTokenSecret creates or updates a secret containing a token

func GetPrivateKeyFromSecret

func GetPrivateKeyFromSecret(ctx context.Context, c client.Client, namespace, name string) (string, error)

GetPrivateKeyFromSecret retrieves the private key from a secret

func IsManaged

func IsManaged(object metav1.Object) bool

IsManaged returns true if the object is under control of the controller by checking the specific annotation

Types

type ClientCredentials

type ClientCredentials struct {
	IssuerURL  string `json:"issuerUrl,omitempty"`
	Audience   string `json:"audience,omitempty"`
	Scope      string `json:"scope,omitempty"`
	PrivateKey string `json:"privateKey,omitempty"`
	ClientID   string `json:"clientId,omitempty"`
}

ClientCredentials represents the client credentials for OAuth2

type Duration

type Duration string

Duration represents a elapsed time in string.

func (*Duration) Parse

func (d *Duration) Parse() (time.Duration, error)

Parse parses a duration from string. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w".

type Event

type Event struct {
	client.Object
}

Event is a custom event that can be used to trigger reconcile

type EventSource

type EventSource struct {
	Log    logr.Logger
	Events chan event.GenericEvent
	// contains filtered or unexported fields
}

EventSource is a custom event source that can be used to trigger reconcile

func NewEventSource

func NewEventSource(log logr.Logger) *EventSource

NewEventSource creates a new EventSource

func (*EventSource) Close

func (s *EventSource) Close()

Close closes the EventSource

func (*EventSource) Contains

func (s *EventSource) Contains(key string) bool

Contains checks if the key exists in the event source

func (*EventSource) CreateIfAbsent

func (s *EventSource) CreateIfAbsent(delay time.Duration, obj client.Object, key string)

CreateIfAbsent triggers reconcile after delay, idempotent operation for the same key

func (*EventSource) Remove

func (s *EventSource) Remove(key string)

Remove removes the reconcile event

func (*EventSource) Update

func (s *EventSource) Update(key string, delay time.Duration)

Update updates the delay of the reconcile event

type ReconcileRetryer

type ReconcileRetryer struct {
	// contains filtered or unexported fields
}

ReconcileRetryer is a helper to trigger reconcile with retry

func NewReconcileRetryer

func NewReconcileRetryer(maxRetries int, source *EventSource) *ReconcileRetryer

NewReconcileRetryer creates a new ReconcileRetryer

func (*ReconcileRetryer) Close

func (r *ReconcileRetryer) Close()

Close closes the ReconcileRetryer

func (*ReconcileRetryer) Contains

func (r *ReconcileRetryer) Contains(obj client.Object) bool

func (*ReconcileRetryer) CreateIfAbsent

func (r *ReconcileRetryer) CreateIfAbsent(obj client.Object)

CreateIfAbsent creates a new task if not exist

func (*ReconcileRetryer) Remove

func (r *ReconcileRetryer) Remove(obj client.Object)

Remove removes the task

func (*ReconcileRetryer) Source

func (r *ReconcileRetryer) Source() <-chan event.GenericEvent

Source returns the event source