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 ConvertStringToInterfaceBySchemaType(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 GeneratePasswordByConfig(config appsv1.PasswordConfig) (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 PodRoleNamePair
Constants ¶
const ( PrometheusScrapeAnnotationPath = "monitor.kubeblocks.io/path" PrometheusScrapeAnnotationPort = "monitor.kubeblocks.io/port" PrometheusScrapeAnnotationScheme = "monitor.kubeblocks.io/scheme" PrometheusScrapeAnnotationEnabled = "monitor.kubeblocks.io/scrape" )
Variables ¶
This section is empty.
Functions ¶
func ConvertStringToInterfaceBySchemaType ¶ added in v0.9.4
func ConvertStringToInterfaceBySchemaType(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, input map[string]string) (map[string]interface{}, error)
func Expand ¶
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 ¶ added in v0.9.0
func FromScheme ¶ added in v0.9.0
func FromScrapePath ¶ added in v0.9.0
func GeneratePasswordByConfig ¶ added in v1.0.1
func GeneratePasswordByConfig(config appsv1.PasswordConfig) (string, error)
func GetFieldRef ¶ added in v0.8.0
GetFieldRef returns the value of the supplied path in the given object
func GetScrapeAnnotations ¶ added in v0.9.0
func IsCompactMode ¶ added in v0.8.0
IsCompactMode tells whether there is a reconciliation compact mode key in the 'annotations'.
func MappingFuncFor ¶
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 ¶ added in v0.8.0
func ToCamelCase ¶ added in v0.8.0
ToCamelCase transforms k8s resource Name with camel case, for examples: - make-food to MakeFood - make.food to MakeFood
func ValidateDataWithSchema ¶ added in v0.8.0
func ValidateDataWithSchema(openAPIV3Schema *apiextensionsv1.JSONSchemaProps, data interface{}) error
ValidateDataWithSchema validates if the data is valid with the jsonSchema.
Types ¶
type Exporter ¶ added in v0.9.0
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 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.
Source Files