utils

Documentation

Index

• Constants
• func AutoSetSelfImpersonationInConfig(cfg *rest.Config)
• 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 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 GetCertificateCommonNameAndOrganizationsFromConfig(cfg *rest.Config) (string, []string)
• func GetCertificateSubject(certificate []byte) (*pkix.Name, error)
• func GetNamespace(ctx context.Context, kubeClient client.Client, name string) (*corev1.Namespace, error)
• func GetServiceAccountSubjectFromConfig(cfg *rest.Config) string
• func GetTokenSubject(token string) (string, error)
• func GetUserInfoFromConfig(cfg *rest.Config) *authv1.UserInfo
• func IsJSONOrYAMLFile(path string) bool
• func IsValidURL(strURL string) bool
• func JoinURL(baseURL, subPath string) (string, error)
• 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)
  • func ParseGitlab(addr, repo string) (string, *Content, error)
• type FileData
  • func LoadDataFromPath(ctx context.Context, path string, pathFilter func(string) bool) ([]FileData, error)
• type GiteeContent
• type GithubContent
• type GitlabContent
• 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 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 AutoSetSelfImpersonationInConfig

func AutoSetSelfImpersonationInConfig(cfg *rest.Config)

AutoSetSelfImpersonationInConfig set impersonate username and group to the identity in the original rest config

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

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

GetNamespace will return a namespace with mutate option

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 IsJSONOrYAMLFile

func IsJSONOrYAMLFile(path string) bool

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