utils

Documentation

Overview

Package utils provides generic utility routines used within FSM.

Index

• func CertToPEM(caBytes []byte) ([]byte, error)
• func ConvertPEMCertToX509(pemCrt []byte) (*x509.Certificate, error)
• func ConvertPEMPrivateKeyToX509(pemKey []byte) (*rsa.PrivateKey, error)
• func CreateOrUpdate(ctx context.Context, c client.Client, obj client.Object) (controllerutil.OperationResult, error)
• func CreateOrUpdateUnstructured(ctx context.Context, dynamicClient dynamic.Interface, mapper meta.RESTMapper, ...) error
• func CsrToPEM(csrBytes []byte) ([]byte, error)
• func DecodeYamlToUnstructured(data []byte) (*unstructured.Unstructured, error)
• func DeleteUnstructured(ctx context.Context, dynamicClient dynamic.Interface, mapper meta.RESTMapper, ...) error
• func ErrorListToError(errorList field.ErrorList) error
• func EvaluateTemplate(t *template.Template, data interface{}) string
• func FilterByIPFamily(ips []string, svc *corev1.Service) ([]string, error)
• func GatewayCodebasePath(namespace string) string
• func GetDefaultGatewaysPath() string
• func GetDefaultIngressPath() string
• func GetDefaultServicesPath() string
• func GetEnv(envVar string, defaultValue string) string
• func GetIPFromContext(ctx context.Context) net.Addr
• func GetLastChunkOfSlashed(s string) string
• func GetSecretDataHash(secret *corev1.Secret) uint32
• func GrpcServe(ctx context.Context, grpcServer *grpc.Server, lis net.Listener, ...)
• func Hash(bytes []byte) uint64
• func HashFromString(s string) (uint64, error)
• func IP2Int(ip net.IP) *big.Int
• func IPv4Tov6(ipv41 string) string
• func ImagePullPolicyByTag(image string) corev1.PullPolicy
• func IngressCodebasePath() string
• func Int2IP16(nn uint64) net.IP
• func Int2IP4(nn uint32) net.IP
• func IsPodStatusConditionPresentAndEqual(conditions []corev1.PodCondition, conditionType corev1.PodConditionType, ...) bool
• func IsPodStatusConditionTrue(conditions []corev1.PodCondition, conditionType corev1.PodConditionType) bool
• func NamespacedIngressCodebasePath(namespace string) string
• func NewGrpc(serverType string, port int, certPem, keyPem, rootCertPem []byte) (*grpc.Server, net.Listener, error)
• func ParseEnabled(enabled string) bool
• func ParseImageName(image string) (string, string, string, error)
• func PipyLogLevelByVerbosity(verbosity string) string
• func PrettyJSON(js []byte, prefix string) ([]byte, error)
• func RSAKeyToPEM(privateKey *rsa.PrivateKey) ([]byte, error)
• func RegisterExitHandlers(shutdownFuncs ...func()) (stop chan struct{})
• func RegisterOSExitHandlers(shutdownFuncs ...func()) (stop chan struct{})
• func SecretNamespaceAndName(secretName string, ing *networkingv1.Ingress) (string, string, error)
• func SimpleHash(obj interface{}) string
• func StringsEqual(left, right []string) bool
• func SvcAccountToK8sSvcAccount(svcAccount *corev1.ServiceAccount) identity.K8sServiceAccount
• func ValidateClient(ctx context.Context) (certificate.CommonName, certificate.SerialNumber, error)

Functions

func CertToPEM

func CertToPEM(caBytes []byte) ([]byte, error)

CertToPEM converts a certificate to PEM format

func ConvertPEMCertToX509

func ConvertPEMCertToX509(pemCrt []byte) (*x509.Certificate, error)

ConvertPEMCertToX509 converts a PEM certificate to x509

func ConvertPEMPrivateKeyToX509

func ConvertPEMPrivateKeyToX509(pemKey []byte) (*rsa.PrivateKey, error)

ConvertPEMPrivateKeyToX509 converts a PEM private key to x509

func CreateOrUpdate

func CreateOrUpdate(ctx context.Context, c client.Client, obj client.Object) (controllerutil.OperationResult, error)

CreateOrUpdate creates or updates the object

func CreateOrUpdateUnstructured

func CreateOrUpdateUnstructured(ctx context.Context, dynamicClient dynamic.Interface, mapper meta.RESTMapper, obj *unstructured.Unstructured) error

func CsrToPEM

func CsrToPEM(csrBytes []byte) ([]byte, error)

CsrToPEM converts a CSR to PEM format

func DecodeYamlToUnstructured

func DecodeYamlToUnstructured(data []byte) (*unstructured.Unstructured, error)

DecodeYamlToUnstructured decodes YAML to Unstructured

func DeleteUnstructured

func DeleteUnstructured(ctx context.Context, dynamicClient dynamic.Interface, mapper meta.RESTMapper, obj *unstructured.Unstructured) error

func ErrorListToError

func ErrorListToError(errorList field.ErrorList) error

ErrorListToError converts a list of errors to a single error

func EvaluateTemplate

func EvaluateTemplate(t *template.Template, data interface{}) string

EvaluateTemplate evaluates the given template with the given data and returns the result as a string.

func FilterByIPFamily

func FilterByIPFamily(ips []string, svc *corev1.Service) ([]string, error)

FilterByIPFamily filters the given list of IPs by the IPFamilyPolicy of the given service.

func GatewayCodebasePath

func GatewayCodebasePath(namespace string) string

GatewayCodebasePath get the codebase URL for the gateway in specified namespace inherit hierarchy: /base/gateways -> /local/gateways -> /local/gw/[ns]

func GetDefaultGatewaysPath

func GetDefaultGatewaysPath() string

GetDefaultGatewaysPath returns the path to the gateways codebase. inherit hierarchy: /base/gateways -> /local/gateways -> /local/gw/[ns]

func GetDefaultIngressPath

func GetDefaultIngressPath() string

GetDefaultIngressPath returns the path to the ingress codebase.

func GetDefaultServicesPath

func GetDefaultServicesPath() string

GetDefaultServicesPath returns the path to the services codebase.

func GetEnv

func GetEnv(envVar string, defaultValue string) string

GetEnv is a convenience wrapper for os.Getenv() with additional default value return when empty or unset

func GetIPFromContext

func GetIPFromContext(ctx context.Context) net.Addr

GetIPFromContext obtains the IP address of the caller from the context.

func GetLastChunkOfSlashed

func GetLastChunkOfSlashed(s string) string

GetLastChunkOfSlashed splits a string by slash and returns the last chunk.

func GetSecretDataHash

func GetSecretDataHash(secret *corev1.Secret) uint32

GetSecretDataHash returns a hash of the given secret data.

func GrpcServe

func GrpcServe(ctx context.Context, grpcServer *grpc.Server, lis net.Listener, cancel context.CancelFunc, serverType string, errorCh chan interface{})

GrpcServe starts the gRPC server passed.

func Hash

func Hash(bytes []byte) uint64

Hash calculates an FNV-1 hash from a given byte array

func HashFromString

func HashFromString(s string) (uint64, error)

HashFromString calculates an FNV-1 hash from a given string, returns it as a uint64 and error, if any

func IP2Int

func IP2Int(ip net.IP) *big.Int

IP2Int converts ip addr to int.

func IPv4Tov6

func IPv4Tov6(ipv41 string) string

func ImagePullPolicyByTag

func ImagePullPolicyByTag(image string) corev1.PullPolicy

ImagePullPolicyByTag returns the pull policy for the given image tag.

func IngressCodebasePath

func IngressCodebasePath() string

IngressCodebasePath returns the path to the ingress codebase.

func Int2IP16

func Int2IP16(nn uint64) net.IP

Int2IP16 converts uint64 to ipv6.

func Int2IP4

func Int2IP4(nn uint32) net.IP

Int2IP4 converts uint32 to ipv4.

func IsPodStatusConditionPresentAndEqual

func IsPodStatusConditionPresentAndEqual(conditions []corev1.PodCondition, conditionType corev1.PodConditionType, status corev1.ConditionStatus) bool

IsPodStatusConditionPresentAndEqual returns true if the pod has the given condition and status.

func IsPodStatusConditionTrue

func IsPodStatusConditionTrue(conditions []corev1.PodCondition, conditionType corev1.PodConditionType) bool

IsPodStatusConditionTrue returns true if the pod is ready.

func NamespacedIngressCodebasePath

func NamespacedIngressCodebasePath(namespace string) string

NamespacedIngressCodebasePath returns the path to the ingress codebase for the given namespace.

func NewGrpc

func NewGrpc(serverType string, port int, certPem, keyPem, rootCertPem []byte) (*grpc.Server, net.Listener, error)

NewGrpc creates a new gRPC server

func ParseEnabled

func ParseEnabled(enabled string) bool

ParseEnabled parses the given string to a boolean value.

func ParseImageName

func ParseImageName(image string) (string, string, string, error)

ParseImageName parses a docker image string into three parts: repo, tag and digest. If both tag and digest are empty, a default image tag will be returned.

func PipyLogLevelByVerbosity

func PipyLogLevelByVerbosity(verbosity string) string

func PrettyJSON

func PrettyJSON(js []byte, prefix string) ([]byte, error)

PrettyJSON Unmarshals and Marshall again with Indent so it is human readable

func RSAKeyToPEM

func RSAKeyToPEM(privateKey *rsa.PrivateKey) ([]byte, error)

RSAKeyToPEM converts a RSA private key to PEM format

func RegisterExitHandlers

func RegisterExitHandlers(shutdownFuncs ...func()) (stop chan struct{})

RegisterExitHandlers registers a shutdown function to be called when a signal is received.

func RegisterOSExitHandlers

func RegisterOSExitHandlers(shutdownFuncs ...func()) (stop chan struct{})

RegisterOSExitHandlers registers a shutdown function to be called when a signal is received.

func SecretNamespaceAndName

func SecretNamespaceAndName(secretName string, ing *networkingv1.Ingress) (string, string, error)

SecretNamespaceAndName returns the namespace and name of the secret.

func SimpleHash

func SimpleHash(obj interface{}) string

SimpleHash returns a hash string of the given object.

func StringsEqual

func StringsEqual(left, right []string) bool

StringsEqual compares two string slices and returns true if they are equal.

func SvcAccountToK8sSvcAccount

func SvcAccountToK8sSvcAccount(svcAccount *corev1.ServiceAccount) identity.K8sServiceAccount

SvcAccountToK8sSvcAccount converts a Kubernetes service to a MeshService.

func ValidateClient

func ValidateClient(ctx context.Context) (certificate.CommonName, certificate.SerialNumber, error)

ValidateClient ensures that the connected client is authorized to connect to the gRPC server.