helper

Documentation

Index

• Constants
• Variables
• func Byte(in interface{}) []byte
• func Contains(t string, a []string) bool
• func CreateFile(p string) (*os.File, error)
• func Download(file, uri string) 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() (err error)
• func NewCfg(ns string) (*action.Configuration, error)
• func NewHelm(ns string) (*helm.EnvSettings, error)
• func SaveInterface(file string, in interface{}) error
• func String(in interface{}) string
• 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.dev/"
)

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(in interface{}) []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 CreateFile

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

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

func Download

func Download(file, uri string) error

Download downloads uri to file.

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() (err error)

KubeInit init kubeconfig for kubedog.

func NewCfg

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

NewCfg creates helm internal configuration for provided namespace.

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(file string, in interface{}) error

SaveInterface encodes input to YAML and saves to file.

func String

func String(in interface{}) string

String marshals input to YAML and returns YAML string.

Types

type EqualChecker

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

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