utils

Documentation

Index

• Constants
• func CreateStepName(moduleName, assetID string) string
• func CreateUnstructured(group, version, kind, name, namespace string) *unstructured.Unstructured
• func GetAuthPath(authPath string) string
• func GetFybrikApplicationUUID(fapp *api.FybrikApplication) string
• func GetFybrikApplicationUUIDfromAnnotations(annotations map[string]string) string
• func GetReleaseName(applicationName, namespace, instanceName string) string
• func GetReleaseNameByStepName(applicationName, namespace, moduleInstanceName string) string
• func HasString(value string, values []string) bool
• func Hash(value string, hashLength int) string
• func HelmConformName(name string) string
• func Intersection(set1, set2 []string) []string
• func IsDenied(actionName taxonomy.ActionName) bool
• func K8sConformName(name string) string
• func ListeningAddress(port int) string
• func NewScheme(g *gomega.WithT) *runtime.Scheme
• func ShortenedName(name string, maxLength, hashLength int) string
• func StructToMap(data interface{}) (map[string]interface{}, error)
• func UpdateStatus(ctx context.Context, cl client.Client, obj client.Object, ...) error
• type UnstructuredAsLabels
  • func (c UnstructuredAsLabels) Get(label string) string
  • func (c UnstructuredAsLabels) Has(label string) bool

Constants

const FybrikAppUUID = "app.fybrik.io/app-uuid"

Functions

func CreateStepName

func CreateStepName(moduleName, assetID string) string

Create a name for a step in a blueprint. Since this is part of the name of a release, this should be done in a central location to make testing easier

func CreateUnstructured

func CreateUnstructured(group, version, kind, name, namespace string) *unstructured.Unstructured

CreateUnstructured creates a new Unstructured runtime object

func GetAuthPath

func GetAuthPath(authPath string) string

GetAuthPath returns the auth method path to use It is of the form v1/auth/<auth path>/login TODO - Different credentials for different data flows (read, write, delete)

func GetFybrikApplicationUUID

func GetFybrikApplicationUUID(fapp *api.FybrikApplication) string

GetFybrikApplicationUUID returns a globally unique ID for the FybrikApplication instance. It must be unique over time and across clusters, even after the instance has been deleted, because this ID will be used for logging purposes.

func GetFybrikApplicationUUIDfromAnnotations

func GetFybrikApplicationUUIDfromAnnotations(annotations map[string]string) string

GetFybrikApplicationUUIDfromAnnotations returns the UUID passed to the resource in its annotations

func GetReleaseName

func GetReleaseName(applicationName, namespace, instanceName string) string

Generating release name based on blueprint module

func GetReleaseNameByStepName

func GetReleaseNameByStepName(applicationName, namespace, moduleInstanceName string) string

Generate release name from blueprint module name

func HasString

func HasString(value string, values []string) bool

func Hash

func Hash(value string, hashLength int) string

Hash generates a name based on the unique identifier

func HelmConformName

func HelmConformName(name string) string

Helm has stricter restrictions than K8s and restricts release names to 53 characters

func Intersection

func Intersection(set1, set2 []string) []string

Intersection finds a common subset of two given sets of strings

func IsDenied

func IsDenied(actionName taxonomy.ActionName) bool

IsDenied returns true if the data access is denied

func K8sConformName

func K8sConformName(name string) string

Some k8s objects only allow for a length of 63 characters. This method shortens the name keeping a prefix and using the last 5 characters of the new name for the hash of the postfix.

func ListeningAddress

func ListeningAddress(port int) string

func NewScheme

func NewScheme(g *gomega.WithT) *runtime.Scheme

Creates a scheme that can be used in unit tests The scheme will have the core and batch apis from K8s registered as well as the app api from Fybrik. This function can be tested with a gomega environment if passed or otherwise (if nil is passed) it will ignore tests.

func ShortenedName

func ShortenedName(name string, maxLength, hashLength int) string

This function shortens a name to the maximum length given and uses rest of the string that is too long as hash that gets added to the valid name.

func StructToMap

func StructToMap(data interface{}) (map[string]interface{}, error)

StructToMap converts a struct to a map using JSON marshal

func UpdateStatus

func UpdateStatus(ctx context.Context, cl client.Client, obj client.Object, previousStatus interface{}) error

UpdateStatus updates the resource status

Types

type UnstructuredAsLabels

type UnstructuredAsLabels struct {
	Data *unstructured.Unstructured
}

UnstructuredAsLabels is an implementation of labels.Labels interface which allows us to take advantage of k8s labels library for the purposes of evaluating fail and success conditions

func (UnstructuredAsLabels) Get

func (c UnstructuredAsLabels) Get(label string) string

Get returns the value for the provided label.

func (UnstructuredAsLabels) Has

func (c UnstructuredAsLabels) Has(label string) bool

Has returns whether the provided label exists.