helper

Documentation

Index

• Constants
• Variables
• func Byte(_ context.Context, in any) []byte
• func Contains(t string, a []string) bool
• func ContextGetLifecycleType(ctx context.Context) (string, bool)
• func ContextGetReleaseUniq(ctx context.Context) (uniqname.UniqName, bool)
• func ContextWithLifecycleType(ctx context.Context, typ string) context.Context
• func ContextWithReleaseUniq(ctx context.Context, name uniqname.UniqName) context.Context
• func CopyFile(src, dest string) error
• func CreateFile(p string) (*os.File, error)
• func Download(ctx context.Context, file, uri string) error
• func GetKubernetesVersion(cfg *action.Configuration) (*version.Info, error)
• func In[T any, C EqualChecker[T]](search C, target []T) bool
• func IsExists(s string) bool
• func IsURL(str string) bool
• func KubeInit(kubecontext string) (err error)
• func MoveFile(src, dst string) error
• func NewCfg(ns, kubecontext string) (*action.Configuration, error)
• func NewHelm(ns string) (*helm.EnvSettings, error)
• func SaveInterface(ctx context.Context, file string, in any) error
• type EqualChecker

Constants

const (
	// HTTPTimeout is a timeout for HTTP requests.
	HTTPTimeout = 30 * time.Second
)

const (
	// RootAnnoName is prefix for all kubedog annotations.
	RootAnnoName = "helmwave.app/"
)

Variables

var (
	// Helm is an instance of helm CLI.
	Helm = helm.New()

	// HelmRegistryClient  is an instance of helm registry client.
	HelmRegistryClient *registry.Client
)

Functions

func Byte

func Byte(_ context.Context, in any) []byte

Byte marshals input to YAML and returns YAML byte slice.

func Contains

func Contains(t string, a []string) bool

Contains checks whether string exists in string slice.

func ContextGetLifecycleType

func ContextGetLifecycleType(ctx context.Context) (string, bool)

func ContextGetReleaseUniq

func ContextGetReleaseUniq(ctx context.Context) (uniqname.UniqName, bool)

func ContextWithLifecycleType

func ContextWithLifecycleType(ctx context.Context, typ string) context.Context

func ContextWithReleaseUniq

func ContextWithReleaseUniq(ctx context.Context, name uniqname.UniqName) context.Context

func CopyFile

func CopyFile(src, dest string) error

CopyFile copy file to dest. Destination is either file or dir.

func CreateFile

func CreateFile(p string) (*os.File, error)

CreateFile creates recursively basedir of file and returns created file object.

func Download

func Download(ctx context.Context, file, uri string) error

Download downloads uri to file.

func GetKubernetesVersion

func GetKubernetesVersion(cfg *action.Configuration) (*version.Info, error)

GetKubernetesVersion returns kubernetes server version.

func In

func In[T any, C EqualChecker[T]](search C, target []T) bool

In returns whether `search` appears in `target` slice.

func IsExists

func IsExists(s string) bool

IsExists return true if file exists.

func IsURL

func IsURL(str string) bool

IsURL reports whether provided string is a valid URL.

func KubeInit

func KubeInit(kubecontext string) (err error)

KubeInit init kubeconfig for kubedog.

func MoveFile

func MoveFile(src, dst string) error

MoveFile moves files or directories. It also handles move between different mounts (copy + rm).

func NewCfg

func NewCfg(ns, kubecontext string) (*action.Configuration, error)

NewCfg creates helm internal configuration for provided namespace and kubecontext.

func NewHelm

func NewHelm(ns string) (*helm.EnvSettings, error)

NewHelm is a hack to create an instance of helm CLI and specifying namespace without environment variables.

func SaveInterface

func SaveInterface(ctx context.Context, file string, in any) error

SaveInterface encodes input to YAML and saves to file.

Types

type EqualChecker

type EqualChecker[T any] interface {
	Equal(T) bool
}

EqualChecker is an interface that allows to check interface for equality.