util

Documentation

Index

• Constants
• Variables
• func CreateVectorShutdownFileCommand() string
• func ExportPodAddress() string
• func GenerateRandomStr(length int, useLetters bool, useSpecial bool, useNum bool) string
• func GenerateSimplePassword(length int) string
• func Indent2SpacesToTab(code string) string
• func Indent4SpacesToTab(code string) string
• func IndentSpacesToTab(code string, spacesPerTab int) string
• func IndentTab2Spaces(code string) string
• func IndentTab4Spaces(code string) string
• func IndentTabToSpaces(code string, spacesPerTab int) string
• func NewEnvVarsFromMap(envs map[string]string) []corev1.EnvVar
• func RemoveSpecialCharacter(str string) string
• func RemoveVectorShutdownFileCommand() string
• type Base64
  • func (b Base64[T]) Decode() (T, error)
  • func (b Base64[T]) Encode() T
• type Image
  • func NewImage(productName string, kubedoopVersion string, productVersion string, ...) *Image
  • func (i *Image) GetImageWithTag() (string, error)
  • func (i *Image) GetPullPolicy() corev1.PullPolicy
  • func (i *Image) String() string
• type ImageOption
• type ImageOptions
• type ResourceNameGenerator
  • func NewResourceNameGenerator(instanceName, roleName, groupName string) *ResourceNameGenerator
  • func NewResourceNameGeneratorOneRole(instanceName, groupName string) *ResourceNameGenerator
  • func (r *ResourceNameGenerator) GenerateResourceName(extraSuffix string) string

Constants

const (
	VectorLogDir = "_vector/"

	// File to signal that Vector should be gracefully shut down
	ShutdownFile = "shutdown"
)

Subdirectory of the log directory containing files to control the Vector instance

const (
	InvokePrepareSignalHandlers = "prepare_signal_handlers"
	InvokeWaitForTermination    = "wait_for_termination $!"
)

const CommonBashTrapFunctions = `` /* 540-byte string literal not displayed */

Variables

var DefaultImagePullPolicy = corev1.PullIfNotPresent

var DefaultRepository = "quay.io/zncdatadev"

Functions

func CreateVectorShutdownFileCommand

func CreateVectorShutdownFileCommand() string

Command to create a shutdown file for the vector container. Please delete it before starting your application using `RemoveVectorShutdownFileCommand` .

func ExportPodAddress

func ExportPodAddress() string

ExportPodAddress fetch the pod address from the default-address directory and export it as POD_ADDRESS the listener was provided by listener operator

func GenerateRandomStr

func GenerateRandomStr(length int, useLetters bool, useSpecial bool, useNum bool) string

GenerateRandomStr generates a random string of the specified length. The string can contain letters, special characters, and numbers based on the flags provided.

func GenerateSimplePassword

func GenerateSimplePassword(length int) string

GenerateSimplePassword generates a simple password of the specified length. The password will contain only letters and numbers.

func Indent2SpacesToTab

func Indent2SpacesToTab(code string) string

func Indent4SpacesToTab

func Indent4SpacesToTab(code string) string

func IndentSpacesToTab

func IndentSpacesToTab(code string, spacesPerTab int) string

IndentSpacesToTab converts leading spaces in a string to tabs, optimized for 2 or 4 spaces per tab.

func IndentTab2Spaces

func IndentTab2Spaces(code string) string

func IndentTab4Spaces

func IndentTab4Spaces(code string) string

func IndentTabToSpaces

func IndentTabToSpaces(code string, spacesPerTab int) string

IndentTabToSpaces converts leading tabs in a string to a specified number of spaces per tab.

func NewEnvVarsFromMap

func NewEnvVarsFromMap(envs map[string]string) []corev1.EnvVar

func RemoveSpecialCharacter

func RemoveSpecialCharacter(str string) string

RemoveSpecialCharacter - remove special character

func RemoveVectorShutdownFileCommand

func RemoveVectorShutdownFileCommand() string

Use this command to remove the shutdown file (if it exists) created by [`create_vector_shutdown_file_command`]. You should execute this command before starting your application.

Types

type Base64

type Base64[T []byte | string] struct {
	Data T
}

func (Base64[T]) Decode

func (b Base64[T]) Decode() (T, error)

func (Base64[T]) Encode

func (b Base64[T]) Encode() T

type Image

type Image struct {
	Custom          string
	Repo            string
	ProductName     string
	KubedoopVersion string
	ProductVersion  string
	PullPolicy      corev1.PullPolicy
	PullSecretName  string
}

Image represents a container image Required fields:

• ProductName
• KubeoopVersion
• ProductVersion

If Custom is set, it will be used as the image tag, so the Custom field must be a valid image tag, eg. "my.repo.company.org/namespace/image:tag"

func NewImage

func NewImage(
	productName string,
	kubedoopVersion string,
	productVersion string,
	opts ...ImageOption,
) *Image

NewImage creates a new Image object

Example:

image := util.NewImage(
	"myproduct",
	"1.0",
	"1.0.0",
)

image := util.NewImage(
	"myproduct",
	"1.0",
	"1.0.0",
	func (options *util.ImageOptions) {
		options.Custom = "myrepo/myimage:latest"
	}
)

func (*Image) GetImageWithTag

func (i *Image) GetImageWithTag() (string, error)

func (*Image) GetPullPolicy

func (i *Image) GetPullPolicy() corev1.PullPolicy

func (*Image) String

func (i *Image) String() string

type ImageOption

type ImageOption func(*ImageOptions)

type ImageOptions

type ImageOptions struct {
	Custom         string
	Repo           string
	PullPolicy     corev1.PullPolicy
	PullSecretName string
}

type ResourceNameGenerator

type ResourceNameGenerator struct {
	InstanceName string
	RoleName     string
	GroupName    string
}

func NewResourceNameGenerator

func NewResourceNameGenerator(instanceName, roleName, groupName string) *ResourceNameGenerator

NewResourceNameGenerator new a ResourceNameGenerator

func NewResourceNameGeneratorOneRole

func NewResourceNameGeneratorOneRole(instanceName, groupName string) *ResourceNameGenerator

NewResourceNameGeneratorOneRole new a ResourceNameGenerator without roleName

func (*ResourceNameGenerator) GenerateResourceName

func (r *ResourceNameGenerator) GenerateResourceName(extraSuffix string) string

GenerateResourceName generate resource Name