utils

Documentation

Index

• Constants
• func ByteCountIEC(b int64) string
• func CreateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• func CreateOrUpdateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• func DumpJSON(o interface{}) string
• func EqualSlice(a, b []string) bool
• func GetBoxDrawingString(up bool, down bool, left bool, right bool, padLeft int, padRight int) string
• func IsValidURL(strURL string) bool
• func MapKey2Array(source map[string]string) []string
• func ParseAPIServerEndpoint(server string) (string, error)
• func RandomString(n int) string
• func Sanitize(s string) string
• func SliceIncludeSlice(a, b []string) bool
• func StrictUnmarshal(bs []byte, dest interface{}) error
• func StringsContain(items []string, source string) bool
• func ThreeWaySliceCompare(a []string, b []string) ([]string, []string, []string)
• func TryCancelRequest(rt http.RoundTripper, req *http.Request)
• func UpdateNamespace(ctx context.Context, kubeClient client.Client, name string, ...) error
• type Content
  • func Parse(addr string) (string, *Content, error)
• type GiteeContent
• type GithubContent
• type LocalContent
• 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 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 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 DumpJSON

func DumpJSON(o interface{}) string

DumpJSON returns the JSON encoding

func EqualSlice

func EqualSlice(a, b []string) bool

EqualSlice checks if two slice are equal

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 IsValidURL

func IsValidURL(strURL string) bool

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

func MapKey2Array

func MapKey2Array(source map[string]string) []string

MapKey2Array convery map keys to array

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 RandomString

func RandomString(n int) string

RandomString generate random string.

func Sanitize

func Sanitize(s string) string

Sanitize the inputs by removing line endings

func SliceIncludeSlice

func SliceIncludeSlice(a, b []string) bool

SliceIncludeSlice the a slice include the b slice

func StrictUnmarshal

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

StrictUnmarshal unmarshal target structure and disallow unknown fields

func StringsContain

func StringsContain(items []string, source string) bool

StringsContain strings contain

func ThreeWaySliceCompare

func ThreeWaySliceCompare(a []string, b []string) ([]string, []string, []string)

ThreeWaySliceCompare will compare two string slice, with the three return values: [both in A and B], [only in A], [only in B]

func TryCancelRequest

func TryCancelRequest(rt http.RoundTripper, req *http.Request)

TryCancelRequest tries to cancel the request by traversing round trippers

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
	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

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 LocalContent

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

LocalContent for local registry

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