utils

Documentation

Index

• Constants
• func ByteCountIEC(b int64) string
• func CreateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• func CreateOrUpdate(ctx context.Context, cli client.Client, obj client.Object) (controllerutil.OperationResult, error)
• func CreateOrUpdateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• func EscapeResourceNameToLabelValue(resourceName string) string
• func FilterObjectsByFieldSelector(objects []runtime.Object, fieldSelector fields.Selector) []runtime.Object
• func GetBoxDrawingString(up bool, down bool, left bool, right bool, padLeft int, padRight int) string
• func GetCertificateCommonNameAndOrganizationsFromConfig(cfg *rest.Config) (string, []string)
• func GetCertificateSubject(certificate []byte) (*pkix.Name, error)
• func GetFilenameFromLocalOrRemote(path string) (string, error)
• func GetNamespace(ctx context.Context, kubeClient client.Client, name string) (*corev1.Namespace, error)
• func GetPodsLogs(ctx context.Context, config *rest.Config, containerName string, ...) error
• func GetServiceAccountSubjectFromConfig(cfg *rest.Config) string
• func GetTokenSubject(token string) (string, error)
• func GetUserInfoFromConfig(cfg *rest.Config) *authv1.UserInfo
• func IsCUEFile(path string) bool
• func IsClusterScope(gvk schema.GroupVersionKind, mapper meta.RESTMapper) (bool, error)
• func IsEmptyDir(path string) (bool, error)
• func IsJSONYAMLorCUEFile(path string) bool
• func IsValidURL(strURL string) bool
• func JoinURL(baseURL, subPath string) (string, error)
• func ParseAPIServerEndpoint(server string) (string, error)
• func PatchNamespace(ctx context.Context, kubeClient client.Client, ns *corev1.Namespace, ...) error
• func ReadRemoteOrLocalPath(pathOrURL string, saveLocal bool) ([]byte, error)
• func Sanitize(s string) string
• func StrictUnmarshal(bs []byte, dest interface{}) error
• func UpdateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• type Content
  • func Parse(addr string) (string, *Content, error)
  • func ParseGitlab(addr, repo string) (string, *Content, error)
• type FileData
  • func LoadDataFromPath(ctx context.Context, path string, pathFilter func(string) bool) ([]FileData, error)
• type FilterFunc
• type GiteeContent
• type GithubContent
• type GitlabContent
• type LocalContent
• type MemoryCacheStore
  • func NewMemoryCacheStore(ctx context.Context) *MemoryCacheStore
  • func (m *MemoryCacheStore) Delete(key interface{})
  • func (m *MemoryCacheStore) Get(key interface{}) (value interface{})
  • func (m *MemoryCacheStore) Put(key, value interface{}, cacheDuration time.Duration)
• type MutateOption
  • func MergeNoConflictLabels(labels map[string]string) MutateOption
  • func MergeOverrideAnnotations(annotations map[string]string) MutateOption
  • func MergeOverrideLabels(labels map[string]string) MutateOption
• type OssContent

Constants

const TypeGitee = "gitee"

TypeGitee represents gitee

const TypeGithub = "github"

TypeGithub represents github

const TypeGitlab = "gitlab"

TypeGitlab represents gitlab

const TypeLocal = "local"

TypeLocal represents github

const TypeOss = "oss"

TypeOss represent oss

const TypeUnknown = "unknown"

TypeUnknown represents parse failed

Functions

func ByteCountIEC

func ByteCountIEC(b int64) string

ByteCountIEC convert number of bytes into readable string borrowed from https://yourbasic.org/golang/formatting-byte-size-to-human-readable-format/

func CreateNamespace

func CreateNamespace(ctx context.Context, kubeClient client.Client, name string, options ...MutateOption) error

CreateNamespace will create a namespace with mutate option

func CreateOrUpdate

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

CreateOrUpdate create or update a kubernetes object

func CreateOrUpdateNamespace

func CreateOrUpdateNamespace(ctx context.Context, kubeClient client.Client, name string, options ...MutateOption) error

CreateOrUpdateNamespace will create a namespace if not exist, it will also update a namespace if exists It will report an error if the labels conflict while it will override the annotations

func EscapeResourceNameToLabelValue

func EscapeResourceNameToLabelValue(resourceName string) string

EscapeResourceNameToLabelValue parse characters in resource name to label valid name

func FilterObjectsByFieldSelector

func FilterObjectsByFieldSelector(objects []runtime.Object, fieldSelector fields.Selector) []runtime.Object

FilterObjectsByFieldSelector supports all field queries per type

func GetBoxDrawingString

func GetBoxDrawingString(up bool, down bool, left bool, right bool, padLeft int, padRight int) string

GetBoxDrawingString get line drawing string, see https://en.wikipedia.org/wiki/Box-drawing_character nolint:gocyclo

func GetCertificateCommonNameAndOrganizationsFromConfig

func GetCertificateCommonNameAndOrganizationsFromConfig(cfg *rest.Config) (string, []string)

GetCertificateCommonNameAndOrganizationsFromConfig extract CommonName and Organizations from Certificate

func GetCertificateSubject

func GetCertificateSubject(certificate []byte) (*pkix.Name, error)

GetCertificateSubject extract Subject from Certificate

func GetFilenameFromLocalOrRemote

func GetFilenameFromLocalOrRemote(path string) (string, error)

GetFilenameFromLocalOrRemote returns the filename of a local path or a URL. It doesn't guarantee that the file or URL actually exists.

func GetNamespace

func GetNamespace(ctx context.Context, kubeClient client.Client, name string) (*corev1.Namespace, error)

GetNamespace will return a namespace with mutate option

func GetPodsLogs

func GetPodsLogs(ctx context.Context, config *rest.Config, containerName string, selectPods []*querytypes.PodBase, tmpl string, logC chan<- string, tailLines *int64) error

GetPodsLogs get logs from pods

func GetServiceAccountSubjectFromConfig

func GetServiceAccountSubjectFromConfig(cfg *rest.Config) string

GetServiceAccountSubjectFromConfig extract ServiceAccountName subject from token

func GetTokenSubject

func GetTokenSubject(token string) (string, error)

GetTokenSubject extract the subject field from the jwt token

func GetUserInfoFromConfig

func GetUserInfoFromConfig(cfg *rest.Config) *authv1.UserInfo

GetUserInfoFromConfig extract UserInfo from KubeConfig

func IsCUEFile

func IsCUEFile(path string) bool

IsCUEFile check if the path is a cue file

func IsClusterScope

func IsClusterScope(gvk schema.GroupVersionKind, mapper meta.RESTMapper) (bool, error)

IsClusterScope check if the gvk is cluster scoped

func IsEmptyDir

func IsEmptyDir(path string) (bool, error)

IsEmptyDir checks if a given path is an empty directory

func IsJSONYAMLorCUEFile

func IsJSONYAMLorCUEFile(path string) bool

IsJSONYAMLorCUEFile check if the path is a json or yaml file

func IsValidURL

func IsValidURL(strURL string) bool

IsValidURL checks whether the given string is a valid URL or not

func JoinURL

func JoinURL(baseURL, subPath string) (string, error)

JoinURL join baseURL and subPath to be new URL

func ParseAPIServerEndpoint

func ParseAPIServerEndpoint(server string) (string, error)

ParseAPIServerEndpoint automatically construct the full url of APIServer It will patch port and scheme if not exists

func PatchNamespace

func PatchNamespace(ctx context.Context, kubeClient client.Client, ns *corev1.Namespace, options ...MutateOption) error

PatchNamespace will patch a namespace

func ReadRemoteOrLocalPath

func ReadRemoteOrLocalPath(pathOrURL string, saveLocal bool) ([]byte, error)

ReadRemoteOrLocalPath will read a path remote or locally

func Sanitize

func Sanitize(s string) string

Sanitize the inputs by removing line endings

func StrictUnmarshal

func StrictUnmarshal(bs []byte, dest interface{}) error

StrictUnmarshal unmarshal target structure and disallow unknown fields

func UpdateNamespace

func UpdateNamespace(ctx context.Context, kubeClient client.Client, name string, options ...MutateOption) error

UpdateNamespace will update a namespace with mutate option

Types

type Content

type Content struct {
	OssContent
	GithubContent
	GiteeContent
	GitlabContent
	LocalContent
}

Content contains different type of content needed when building Registry

func Parse

func Parse(addr string) (string, *Content, error)

Parse will parse config from address

func ParseGitlab

func ParseGitlab(addr, repo string) (string, *Content, error)

ParseGitlab will parse gitlab config from address

type FileData

type FileData struct {
	Path string
	Data []byte
}

FileData data of a file at the path

func LoadDataFromPath

func LoadDataFromPath(ctx context.Context, path string, pathFilter func(string) bool) ([]FileData, error)

LoadDataFromPath load FileData from path If path is an url, fetch the data from the url If path is a file, fetch the data from the file If path is a dir, fetch the data from all the files inside the dir that passes the pathFilter

type FilterFunc

type FilterFunc func(object runtime.Object) bool

FilterFunc return true if object contains field selector

type GiteeContent

type GiteeContent struct {
	Owner string `json:"gitee_owner"`
	Repo  string `json:"gitee_repo"`
	Path  string `json:"gitee_path"`
	Ref   string `json:"gitee_ref"`
}

GiteeContent for cap center

type GithubContent

type GithubContent struct {
	Owner string `json:"owner"`
	Repo  string `json:"repo"`
	Path  string `json:"path"`
	Ref   string `json:"ref"`
}

GithubContent for cap center

type GitlabContent

type GitlabContent struct {
	Host  string `json:"gitlab_host"`
	Owner string `json:"gitlab_owner"`
	Repo  string `json:"gitlab_repo"`
	Path  string `json:"gitlab_path"`
	Ref   string `json:"gitlab_ref"`
	PId   int    `json:"gitlab_pid"`
}

GitlabContent for cap center

type LocalContent

type LocalContent struct {
	AbsDir string `json:"abs_dir"`
}

LocalContent for local registry

type MemoryCacheStore

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

MemoryCacheStore a sample memory cache instance, if data set cache duration, will auto clear after timeout. But, Expired cleanup is not necessarily accurate, it has a 3-second window.

func NewMemoryCacheStore

func NewMemoryCacheStore(ctx context.Context) *MemoryCacheStore

NewMemoryCacheStore memory cache store

func (*MemoryCacheStore) Delete

func (m *MemoryCacheStore) Delete(key interface{})

Delete cache data from store

func (*MemoryCacheStore) Get

func (m *MemoryCacheStore) Get(key interface{}) (value interface{})

Get cache data from store, if not exist or timeout, will return nil

func (*MemoryCacheStore) Put

func (m *MemoryCacheStore) Put(key, value interface{}, cacheDuration time.Duration)

Put cache data, if cacheDuration>0, store will clear data after timeout.

type MutateOption

type MutateOption func(object metav1.Object) error

MutateOption defines the function pattern for mutate

func MergeNoConflictLabels

func MergeNoConflictLabels(labels map[string]string) MutateOption

MergeNoConflictLabels will merge the existing labels with the labels passed in, it will report conflicts if exists

func MergeOverrideAnnotations

func MergeOverrideAnnotations(annotations map[string]string) MutateOption

MergeOverrideAnnotations will merge the existing annotations and override by the annotations passed in

func MergeOverrideLabels

func MergeOverrideLabels(labels map[string]string) MutateOption

MergeOverrideLabels will merge the existing labels and override by the labels passed in

type OssContent

type OssContent struct {
	EndPoint string `json:"bucket_url"`
	Bucket   string `json:"bucket"`
}

OssContent for oss registry