util

Documentation

Index

• Constants
• func ApplyAnnotation(ctx context.Context, kubeClient client.Client, obj client.Object, ...) error
• func ApplyTemplate(in []byte, templateData any) ([]byte, error)
• func CloneRemoteRepoToDir(ctx context.Context, remote v1alpha1.RemoteRepositorySpec, depth int, ...) (billy.Filesystem, *git.Repository, error)
• func CloneRemoteRepoToMemory(ctx context.Context, remote v1alpha1.RemoteRepositorySpec, depth int, ...) (billy.Filesystem, *git.Repository, error)
• func ConvertFSToBytes(inFS FS, name string, templateData any) ([][]byte, error)
• func Copy(srcFile, dstFile string) error
• func CopyDir(src fs.FS, dest string) error
• func CopyDirectory(scrDir, dest string) error
• func CopyFile(src fs.File, dest string) error
• func CopyTreeToTree(srcWT, dstWT billy.Filesystem, srcPath, dstPath string) error
• func CopyWTFile(srcWT, dstWT billy.Filesystem, srcFile, dstFile string) error
• func CreateIfNotExists(dir string, perm os.FileMode) error
• func DetectKindNodeProvider() (cluster.ProviderOption, error)
• func Exists(filePath string) bool
• func FirstRemoteURL(repo *git.Repository) (string, error)
• func GeneratePassword() (string, error)
• func GetCLIStartTimeAnnotationValue(annotations map[string]string) (string, error)
• func GetHttpClient() *http.Client
• func GetLastObservedSyncTimeAnnotationValue(annotations map[string]string) (string, error)
• func GetWorktreeYamlFiles(parent string, wt billy.Filesystem, recurse bool) ([]string, error)
• func IsYamlFile(input string) bool
• func ReadWorktreeFile(wt billy.Filesystem, path string) ([]byte, error)
• func RepoDir(repoUrl, parent string) string
• func RepoUrlHash(repoUrl string) string
• func SetCLIStartTimeAnnotationValue(annotations map[string]string, timeStamp string)
• func SetLastObservedSyncTimeAnnotationValue(annotations map[string]string, timeStamp string)
• func UpdateSyncAnnotation(ctx context.Context, kubeClient client.Client, obj client.Object) error
• func WriteFS(src fs.FS, dest string) error
• type FS
• type KustomizeRemote
  • func NewKustomizeRemote(uri string) (*KustomizeRemote, error)
  • func (g *KustomizeRemote) CloneUrl() string
  • func (g *KustomizeRemote) Path() string
• type RepoMap
  • func NewRepoLock() *RepoMap
  • func (r *RepoMap) LoadOrStore(repoName, dir string) *RepoState
• type RepoState

Constants

const (
	QueryStringRef        = "ref"
	QueryStringVersion    = "version"
	QueryStringTimeout    = "timeout"
	QueryStringSubmodules = "submodules"

	RepoUrlDelimiter = "//"
	SCPDelimiter     = ":"
	UserDelimiter    = "@"
)

constants from remote target parameters supported by Kustomize https://github.com/kubernetes-sigs/kustomize/blob/master/examples/remoteBuild.md

Functions

func ApplyAnnotation

func ApplyAnnotation(ctx context.Context, kubeClient client.Client, obj client.Object, annotations map[string]string, opts ...client.PatchOption) error

func ApplyTemplate

func ApplyTemplate(in []byte, templateData any) ([]byte, error)

func CloneRemoteRepoToDir

func CloneRemoteRepoToDir(ctx context.Context, remote v1alpha1.RemoteRepositorySpec, depth int, insecureSkipTLS bool, dir, fallbackUrl string) (billy.Filesystem, *git.Repository, error)

func CloneRemoteRepoToMemory

func CloneRemoteRepoToMemory(ctx context.Context, remote v1alpha1.RemoteRepositorySpec, depth int, insecureSkipTLS bool) (billy.Filesystem, *git.Repository, error)

func ConvertFSToBytes

func ConvertFSToBytes(inFS FS, name string, templateData any) ([][]byte, error)

func Copy

func Copy(srcFile, dstFile string) error

func CopyDir

func CopyDir(src fs.FS, dest string) error

func CopyDirectory

func CopyDirectory(scrDir, dest string) error

func CopyFile

func CopyFile(src fs.File, dest string) error

func CopyTreeToTree

func CopyTreeToTree(srcWT, dstWT billy.Filesystem, srcPath, dstPath string) error

func CopyWTFile

func CopyWTFile(srcWT, dstWT billy.Filesystem, srcFile, dstFile string) error

func CreateIfNotExists

func CreateIfNotExists(dir string, perm os.FileMode) error

func DetectKindNodeProvider

func DetectKindNodeProvider() (cluster.ProviderOption, error)

DetectKindNodeProvider follows the kind CLI convention where: 1. if KIND_EXPERIMENTAL_PROVIDER env var is specified, it uses the value: 2. if env var is not specified, use the first available supported engine. https://github.com/kubernetes-sigs/kind/blob/ac81e7b64e06670132dae3486e64e531953ad58c/pkg/cluster/provider.go#L100-L114

func Exists

func Exists(filePath string) bool

func FirstRemoteURL

func FirstRemoteURL(repo *git.Repository) (string, error)

func GeneratePassword

func GeneratePassword() (string, error)

func GetCLIStartTimeAnnotationValue

func GetCLIStartTimeAnnotationValue(annotations map[string]string) (string, error)

func GetHttpClient

func GetHttpClient() *http.Client

func GetLastObservedSyncTimeAnnotationValue

func GetLastObservedSyncTimeAnnotationValue(annotations map[string]string) (string, error)

func GetWorktreeYamlFiles

func GetWorktreeYamlFiles(parent string, wt billy.Filesystem, recurse bool) ([]string, error)

returns all files with yaml or yml suffix from a worktree

func IsYamlFile

func IsYamlFile(input string) bool

func ReadWorktreeFile

func ReadWorktreeFile(wt billy.Filesystem, path string) ([]byte, error)

func RepoDir

func RepoDir(repoUrl, parent string) string

func RepoUrlHash

func RepoUrlHash(repoUrl string) string

func SetCLIStartTimeAnnotationValue

func SetCLIStartTimeAnnotationValue(annotations map[string]string, timeStamp string)

func SetLastObservedSyncTimeAnnotationValue

func SetLastObservedSyncTimeAnnotationValue(annotations map[string]string, timeStamp string)

func UpdateSyncAnnotation

func UpdateSyncAnnotation(ctx context.Context, kubeClient client.Client, obj client.Object) error

func WriteFS

func WriteFS(src fs.FS, dest string) error

Types

type FS

type FS interface {
	ReadDir(name string) ([]fs.DirEntry, error)
	ReadFile(name string) ([]byte, error)
}

type KustomizeRemote

type KustomizeRemote struct {
	Scheme   string
	User     string
	Password string
	Host     string
	Port     string
	RepoPath string

	FilePath string

	Ref        string
	Submodules bool
	Timeout    time.Duration
	// contains filtered or unexported fields
}

func NewKustomizeRemote

func NewKustomizeRemote(uri string) (*KustomizeRemote, error)

func (*KustomizeRemote) CloneUrl

func (g *KustomizeRemote) CloneUrl() string

func (*KustomizeRemote) Path

func (g *KustomizeRemote) Path() string

type RepoMap

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

func NewRepoLock

func NewRepoLock() *RepoMap

func (*RepoMap) LoadOrStore

func (r *RepoMap) LoadOrStore(repoName, dir string) *RepoState

type RepoState

type RepoState struct {
	MU  sync.Mutex
	Dir string
}