util

Documentation

Index

• Constants
• Variables
• func AppNamespace() string
• func Base64DecodeInterface(d interface{}) ([]byte, error)
• func CommonSlicePrefix(first []string, second []string) []string
• func CompareStringArrays(arr1, arr2 []string) bool
• func ConvertToSingleDocs(doc []byte) [][]byte
• func DecryptConfigValue(input string) (string, error)
• func DefaultProxyRegistryDomain() string
• func DefaultReplicatedRegistryDomain() string
• func EmbeddedClusterDataDir() string
• func EmbeddedClusterID() string
• func EmbeddedClusterK0sDir() string
• func EmbeddedClusterVersion() string
• func ExtractReadableText(data []byte) string
• func ExtractTGZArchive(tgzFile string, destDir string) error
• func FilesToTGZ(files map[string]string) ([]byte, error)
• func GenPassword(length int) string
• func GetFileFromTGZArchive(archive *bytes.Buffer, fileName string) (*bytes.Buffer, error)
• func GetFilesMap(dir string) (map[string][]byte, error)
• func GetValueFromMapPath(m interface{}, path []string) interface{}
• func GunzipData(input []byte) ([]byte, error)
• func GzipData(input []byte) ([]byte, error)
• func HTTPProxy() string
• func HTTPSProxy() string
• func HomeDir() string
• func IntPointer(x int) *int64
• func IsEmbeddedCluster() bool
• func IsURL(str string) bool
• func IsUpgradeService() bool
• func MarshalIndent(indent int, in interface{}) ([]byte, error)
• func NewRequest(method string, url string, body io.Reader) (*http.Request, error)
• func NewRetryableRequest(method string, url string, body io.Reader) (*retryablehttp.Request, error)
• func NewThrottle(after time.Duration) func(f func())
• func NoProxy() string
• func PromptForNewPassword() (string, error)
• func ReplicatedAppEndpoint(license *kotsv1beta1.License) string
• func SplitStringOnLen(str string, maxLength int) ([]string, error)
• func SplitYAML(input []byte) (map[string][]byte, error)
• func StrPointer(s string) *string
• func TGZArchive(dir string) ([]byte, error)
• func TGZToFiles(tgzBytes []byte) (map[string]string, error)
• func TestGetenv(key string) string
• func ThisImage(ctx context.Context, client kubernetes.Interface) (string, error)
• type ActionableError
  • func (e ActionableError) Error() string
• type CachingReader
  • func NewCachingReader(r io.Reader, size int) *CachingReader
  • func (c *CachingReader) GetCachedBytes() []byte
  • func (c *CachingReader) LogReadableText(message string)
  • func (c *CachingReader) Read(p []byte) (n int, err error)
• type OverlySimpleGVK
• type OverlySimpleMetadata

Constants

const (
	PasswordSecretName = "kotsadm-password"
	SessionsSecretName = "kotsadm-sessions"
)

Variables

var (
	PodNamespace           string = os.Getenv("POD_NAMESPACE")
	KotsadmTargetNamespace string = os.Getenv("KOTSADM_TARGET_NAMESPACE")
)

var DefaultHTTPClient *retryablehttp.Client

Functions

func AppNamespace

func AppNamespace() string

func Base64DecodeInterface

func Base64DecodeInterface(d interface{}) ([]byte, error)

func CommonSlicePrefix

func CommonSlicePrefix(first []string, second []string) []string

func CompareStringArrays

func CompareStringArrays(arr1, arr2 []string) bool

CompareStringArrays returns true if all elements in arr1 are present in arr2 and the other way around. it does not check for equal counts of duplicates, or for ordering.

func ConvertToSingleDocs

func ConvertToSingleDocs(doc []byte) [][]byte

func DecryptConfigValue

func DecryptConfigValue(input string) (string, error)

func DefaultProxyRegistryDomain

func DefaultProxyRegistryDomain() string

func DefaultReplicatedRegistryDomain

func DefaultReplicatedRegistryDomain() string

func EmbeddedClusterDataDir

func EmbeddedClusterDataDir() string

func EmbeddedClusterID

func EmbeddedClusterID() string

func EmbeddedClusterK0sDir

func EmbeddedClusterK0sDir() string

func EmbeddedClusterVersion

func EmbeddedClusterVersion() string

func ExtractReadableText

func ExtractReadableText(data []byte) string

ExtractReadableText takes potentially binary data and extracts human-readable portions to help with debugging. It tries to preserve meaningful text sections while replacing binary sections with "..." placeholders.

func ExtractTGZArchive

func ExtractTGZArchive(tgzFile string, destDir string) error

func FilesToTGZ

func FilesToTGZ(files map[string]string) ([]byte, error)

func GenPassword

func GenPassword(length int) string

generates a [0-9a-zA-Z] password of the specified length

func GetFileFromTGZArchive

func GetFileFromTGZArchive(archive *bytes.Buffer, fileName string) (*bytes.Buffer, error)

func GetFilesMap

func GetFilesMap(dir string) (map[string][]byte, error)

func GetValueFromMapPath

func GetValueFromMapPath(m interface{}, path []string) interface{}

func GunzipData

func GunzipData(input []byte) ([]byte, error)

func GzipData

func GzipData(input []byte) ([]byte, error)

func HTTPProxy

func HTTPProxy() string

func HTTPSProxy

func HTTPSProxy() string

func HomeDir

func HomeDir() string

func IntPointer

func IntPointer(x int) *int64

func IsEmbeddedCluster

func IsEmbeddedCluster() bool

func IsURL

func IsURL(str string) bool

func IsUpgradeService

func IsUpgradeService() bool

func MarshalIndent

func MarshalIndent(indent int, in interface{}) ([]byte, error)

func NewRequest

func NewRequest(method string, url string, body io.Reader) (*http.Request, error)

NewRequest returns a http.Request object with kots defaults set, including a User-Agent header.

func NewRetryableRequest

func NewRetryableRequest(method string, url string, body io.Reader) (*retryablehttp.Request, error)

NewRetryableRequest returns a retryablehttp.Request object with kots defaults set, including a User-Agent header.

func NewThrottle

func NewThrottle(after time.Duration) func(f func())

func NoProxy

func NoProxy() string

func PromptForNewPassword

func PromptForNewPassword() (string, error)

func ReplicatedAppEndpoint

func ReplicatedAppEndpoint(license *kotsv1beta1.License) string

ReplicatedAPIEndpoint returns the endpoint for the replicated.app API.

func SplitStringOnLen

func SplitStringOnLen(str string, maxLength int) ([]string, error)

func SplitYAML

func SplitYAML(input []byte) (map[string][]byte, error)

func StrPointer

func StrPointer(s string) *string

func TGZArchive

func TGZArchive(dir string) ([]byte, error)

func TGZToFiles

func TGZToFiles(tgzBytes []byte) (map[string]string, error)

func TestGetenv

func TestGetenv(key string) string

func ThisImage

func ThisImage(ctx context.Context, client kubernetes.Interface) (string, error)

ThisImage looks for either a deployment 'kotsadm' or a statefulset 'kotsadm' in the current namespace it returns the image of the first container in the pod template

Types

type ActionableError

type ActionableError struct {
	NoRetry bool
	Message string
}

func (ActionableError) Error

func (e ActionableError) Error() string

type CachingReader

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

CachingReader is a reader that caches the last N bytes read to help with debugging when encountering errors in tar or gzip extraction

func NewCachingReader

func NewCachingReader(r io.Reader, size int) *CachingReader

NewCachingReader creates a new caching reader that caches the last size bytes

func (*CachingReader) GetCachedBytes

func (c *CachingReader) GetCachedBytes() []byte

GetCachedBytes returns the last bytes read up to size

func (*CachingReader) LogReadableText

func (c *CachingReader) LogReadableText(message string)

func (*CachingReader) Read

func (c *CachingReader) Read(p []byte) (n int, err error)

Read implements io.Reader

type OverlySimpleGVK

type OverlySimpleGVK struct {
	APIVersion string               `yaml:"apiVersion"`
	Kind       string               `yaml:"kind"`
	Metadata   OverlySimpleMetadata `yaml:"metadata"`
}

type OverlySimpleMetadata

type OverlySimpleMetadata struct {
	Name      string `yaml:"name"`
	Namespace string `yaml:"namespace"`
}