common

Documentation

Overview

Package common provides types and utils shared by all KubeBlocks components: KubeBlocks Core, KBCLI etc. will promote to pkg/common when stable.

Index

• Constants
• func CoverStringToInterfaceBySchemaType(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, input map[string]string) (map[string]interface{}, error)
• func CutString(str string, length int) string
• func Expand(input string, mapping func(string) string) string
• func FromContainerPort(exporter Exporter, container *corev1.Container) string
• func FromScheme(exporter appsv1.Exporter) string
• func FromScrapePath(exporter appsv1.Exporter) string
• func GeneratePassword(length, numDigits, numSymbols int, noUpper bool, seed string) (string, error)
• func GetFieldRef(pod *corev1.Pod, from *corev1.EnvVarSource) (string, error)
• func GetScrapeAnnotations(exporter Exporter, container *corev1.Container) map[string]string
• func IsCompactMode(annotations map[string]string) bool
• func MappingFuncFor(context ...map[string]string) func(string) string
• func SafeAddInt(a, b int) int
• func ToCamelCase(input string) string
• func ValidateDataWithSchema(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, data interface{}) error
• type Exporter
• type GlobalRoleSnapshot
• type NameGenerator
• type PasswordReader
  • func (r *PasswordReader) Read(data []byte) (int, error)
  • func (r *PasswordReader) Seed(seed int64)
• type PodRoleNamePair

Constants

const (
	PrometheusScrapeAnnotationPath    = "monitor.kubeblocks.io/path"
	PrometheusScrapeAnnotationPort    = "monitor.kubeblocks.io/port"
	PrometheusScrapeAnnotationScheme  = "monitor.kubeblocks.io/scheme"
	PrometheusScrapeAnnotationEnabled = "monitor.kubeblocks.io/scrape"
)

const (
	MaxGeneratedNameLength = maxNameLength - randomLength
)

const (
	// Symbols is the list of symbols.
	Symbols = "!@#&*"
)

Functions

func CoverStringToInterfaceBySchemaType

func CoverStringToInterfaceBySchemaType(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, input map[string]string) (map[string]interface{}, error)

func CutString

func CutString(str string, length int) string

CutString cuts the string with specified length.

func Expand

func Expand(input string, mapping func(string) string) string

Expand replaces variable references in the input string according to the expansion spec using the given mapping function to resolve the values of variables.

func FromContainerPort

func FromContainerPort(exporter Exporter, container *corev1.Container) string

func FromScheme

func FromScheme(exporter appsv1.Exporter) string

func FromScrapePath

func FromScrapePath(exporter appsv1.Exporter) string

func GeneratePassword

func GeneratePassword(length, numDigits, numSymbols int, noUpper bool, seed string) (string, error)

GeneratePassword generates a password with the given requirements and seed.

func GetFieldRef

func GetFieldRef(pod *corev1.Pod, from *corev1.EnvVarSource) (string, error)

GetFieldRef returns the value of the supplied path in the given object

func GetScrapeAnnotations

func GetScrapeAnnotations(exporter Exporter, container *corev1.Container) map[string]string

func IsCompactMode

func IsCompactMode(annotations map[string]string) bool

IsCompactMode tells whether there is a reconciliation compact mode key in the 'annotations'.

func MappingFuncFor

func MappingFuncFor(context ...map[string]string) func(string) string

MappingFuncFor returns a mapping function for use with Expand that implements the expansion semantics defined in the expansion spec; it returns the input string wrapped in the expansion syntax if no mapping for the input is found.

func SafeAddInt

func SafeAddInt(a, b int) int

func ToCamelCase

func ToCamelCase(input string) string

ToCamelCase transforms k8s resource Name with camel case, for examples: - make-food to MakeFood - make.food to MakeFood

func ValidateDataWithSchema

func ValidateDataWithSchema(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, data interface{}) error

ValidateDataWithSchema validates if the data is valid with the jsonSchema.

Types

type Exporter

type Exporter struct {
	appsv1.Exporter `json:",inline"`
	TargetPort      *intstr.IntOrString `json:"targetPort,omitempty"`
}

Exporter defines the built-in metrics exporter.

type GlobalRoleSnapshot

type GlobalRoleSnapshot struct {
	Version          string            `json:"term,omitempty"`
	PodRoleNamePairs []PodRoleNamePair `json:"PodRoleNamePairs,omitempty"`
}

GlobalRoleSnapshot defines a global(leader) perspective of all pods role. KB provides two role probe methods: per-pod level role probe and retrieving all node roles from the leader node. The latter is referred to as the global role snapshot. This data structure is used to represent a snapshot of global role information. The snapshot contains two types of information: the mapping relationship between all node names and role names, and the version of the snapshot. The purpose of the snapshot version is to ensure that only role information that is more up-to-date than the current role information on the Pod Label will be updated. This resolves the issue of role information disorder in scenarios such as KB upgrades or exceptions causing restarts, network partitioning leading to split-brain situations, node crashes, and similar occurrences.

type NameGenerator

type NameGenerator interface {
	// GenerateName generates a valid name from the base name, adding a random suffix to the
	// the base. If base is valid, the returned name must also be valid. The generator is
	// responsible for knowing the maximum valid name length.
	GenerateName(base string) string
}

NameGenerator generates names for objects. Some backends may have more information available to guide selection of new names and this interface hides those details.

var SimpleNameGenerator NameGenerator = simpleNameGenerator{}

SimpleNameGenerator is a generator that returns the name plus a random suffix of five alphanumerics when a name is requested. The string is guaranteed to not exceed the length of a standard Kubernetes name (63 characters)

type PasswordReader

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

func (*PasswordReader) Read

func (r *PasswordReader) Read(data []byte) (int, error)

func (*PasswordReader) Seed

func (r *PasswordReader) Seed(seed int64)

type PodRoleNamePair

type PodRoleNamePair struct {
	PodName  string `json:"podName,omitempty"`
	RoleName string `json:"roleName,omitempty"`
	PodUID   string `json:"podUid,omitempty"`
}

PodRoleNamePair defines a pod name and role name pair.