util

Documentation

Index

• func BackupIfPresent(fs afero.Afero, basePath string, logger log.Logger, ui cli.Ui) error
• func BailIfPresent(fs afero.Afero, basePath string, logger log.Logger) error
• func ExcludeKubernetesPatch(fs afero.Afero, basePath string, excludedResource resid.ResId) error
• func ExcludeKubernetesResource(fs afero.Afero, basePath string, excludedResource string) ([]resid.ResId, error)
• func ExcludeKubernetesResources(fs afero.Afero, basePath string, overlaysPath string, ...) error
• func FindOnlySubdir(dir string, fs afero.Afero) (string, error)
• func GenerateNameFromMetadata(k8sYaml MinimalK8sYaml, idx int) string
• func IsGithubURL(url string) bool
• func IsK8sYaml(fs *afero.Afero, target string) bool
• func IsLegalPath(path string) error
• func MarshalIndent(indent int, in interface{}) ([]byte, error)
• func MaybeSplitMultidocYaml(ctx context.Context, fs afero.Afero, localPath string) error
• func NewKubernetesResource(in []byte) (*resource.Resource, error)
• func NewKubernetesResources(in []byte) ([]*resource.Resource, error)
• func RecursiveCopy(fs afero.Afero, sourceDir, destDir string) error
• func RecursiveNormalizeCopyKustomize(fs afero.Afero, sourceDir, destDir string) error
• func ResIDs(in []*resource.Resource) (generated []resid.ResId)
• func ShouldAddFileToBase(fs *afero.Afero, excludedBases []string, targetPath string) bool
• func SplitAllKustomize(fs afero.Afero, path string) error
• func TimeToExpire(cert []byte) (time.Duration, error)
• func ToGroupVersionKind(in gvk.Gvk) schema.GroupVersionKind
• func UnExcludeKubernetesResource(fs afero.Afero, basePath string, unExcludedResource string) error
• func WritePostKustomizeFiles(debug log.Logger, FS afero.Afero, dest string, ...) error
• type AssetUploader
  • func NewAssetUploader(logger log.Logger, client *http.Client) AssetUploader
• type CAType
  • func MakeCA(caKind string) (CAType, error)
  • func RenewCA(ca CAType) (CAType, error)
• type CertType
  • func MakeCert(host []string, certKind, CACert, CAKey string) (CertType, error)
• type GithubURL
  • func ParseGithubURL(url string, defaultRef string) (GithubURL, error)
  • func (g GithubURL) URL() string
• type ListK8sYaml
• type MinimalK8sMetadata
• type MinimalK8sYaml
• type PostKustomizeFile
• type PostKustomizeFileCollection
  • func (c PostKustomizeFileCollection) Len() int
  • func (c PostKustomizeFileCollection) Less(i, j int) bool
  • func (c PostKustomizeFileCollection) Swap(i, j int)

Functions

func BackupIfPresent

func BackupIfPresent(fs afero.Afero, basePath string, logger log.Logger, ui cli.Ui) error

func BailIfPresent

func BailIfPresent(fs afero.Afero, basePath string, logger log.Logger) error

BailIfPresent returns an error if the path is present. Handy to prevent accidentally blowing away directories on the workstation.

func ExcludeKubernetesPatch

func ExcludeKubernetesPatch(fs afero.Afero, basePath string, excludedResource resid.ResId) error

for the provided base and all subbases, check each strategic merge patch and json patch if they match the resid provided, remove them

func ExcludeKubernetesResource

func ExcludeKubernetesResource(fs afero.Afero, basePath string, excludedResource string) ([]resid.ResId, error)

exclude the provided kubernetes resource file from the kustomization.yaml at basePath, or from bases imported from that.

func ExcludeKubernetesResources

func ExcludeKubernetesResources(fs afero.Afero, basePath string, overlaysPath string, excludedResources []string) error

calls ExcludeKubernetesResource for each excluded resource. Returns after the first error.

func FindOnlySubdir

func FindOnlySubdir(dir string, fs afero.Afero) (string, error)

FindOnlySubdir finds the only subdirectory of a directory.

func GenerateNameFromMetadata

func GenerateNameFromMetadata(k8sYaml MinimalK8sYaml, idx int) string

func IsGithubURL

func IsGithubURL(url string) bool

returns true if this parses as a valid Github URL.

func IsK8sYaml

func IsK8sYaml(fs *afero.Afero, target string) bool

func IsLegalPath

func IsLegalPath(path string) error

IsLegalPath checks if the provided path is a relative path within the current working directory or within the os tempdir. If it is not, it returns an error.

func MarshalIndent

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

func MaybeSplitMultidocYaml

func MaybeSplitMultidocYaml(ctx context.Context, fs afero.Afero, localPath string) error

this function is not perfect, and has known limitations. One of these is that it does not account for `\n---\n` in multiline strings.

func NewKubernetesResource

func NewKubernetesResource(in []byte) (*resource.Resource, error)

func NewKubernetesResources

func NewKubernetesResources(in []byte) ([]*resource.Resource, error)

func RecursiveCopy

func RecursiveCopy(fs afero.Afero, sourceDir, destDir string) error

func RecursiveNormalizeCopyKustomize

func RecursiveNormalizeCopyKustomize(fs afero.Afero, sourceDir, destDir string) error

RecursiveNormalizeCopyKustomize copies kubernetes yaml from the source directory into the dest directory. `kustomization.yaml` files are skipped. if `kustomization.yaml` contains any bases, those bases are recursively copied into `destDir/<base-name>/`

func ResIDs

func ResIDs(in []*resource.Resource) (generated []resid.ResId)

func ShouldAddFileToBase

func ShouldAddFileToBase(fs *afero.Afero, excludedBases []string, targetPath string) bool

func SplitAllKustomize

func SplitAllKustomize(fs afero.Afero, path string) error

SplitAllKustomize ensures that all yaml files within the designated directory are split into one resource per file, excepting CRDs if a kustomization yaml existed beforehand, it rewrites the resource list to match the new filenames if not, it creates a kustomization yaml if an existing kustomization yaml referred to other bases, splitAll will be called on those bases as well

func TimeToExpire

func TimeToExpire(cert []byte) (time.Duration, error)

TimeToExpire takes a certificate, parses it, and returns the duration left until the certificate expires.

func ToGroupVersionKind

func ToGroupVersionKind(in gvk.Gvk) schema.GroupVersionKind

func UnExcludeKubernetesResource

func UnExcludeKubernetesResource(fs afero.Afero, basePath string, unExcludedResource string) error

UnExcludeKubernetesResource finds a deleted resource in a child of the basePath and includes it again

func WritePostKustomizeFiles

func WritePostKustomizeFiles(debug log.Logger, FS afero.Afero, dest string, postKustomizeFiles []PostKustomizeFile) error

Types

type AssetUploader

type AssetUploader interface {
	UploadAssets(target string) error
}

func NewAssetUploader

func NewAssetUploader(
	logger log.Logger,
	client *http.Client,
) AssetUploader

type CAType

type CAType struct {
	Cert string
	Key  string
}

func MakeCA

func MakeCA(caKind string) (CAType, error)

func RenewCA

func RenewCA(ca CAType) (CAType, error)

RenewCA takes an existing CA and generates a new certificate with the notBefore/notAfter dates updated.

type CertType

type CertType struct {
	Cert string
	Key  string
}

func MakeCert

func MakeCert(host []string, certKind, CACert, CAKey string) (CertType, error)

type GithubURL

type GithubURL struct {
	Owner  string
	Repo   string
	Ref    string
	Subdir string
	IsBlob bool
}

func ParseGithubURL

func ParseGithubURL(url string, defaultRef string) (GithubURL, error)

func (GithubURL) URL

func (g GithubURL) URL() string

type ListK8sYaml

type ListK8sYaml struct {
	APIVersion string        `json:"apiVersion" yaml:"apiVersion"`
	Kind       string        `json:"kind" yaml:"kind" hcl:"kind"`
	Items      []interface{} `json:"items" yaml:"items"`
}

type MinimalK8sMetadata

type MinimalK8sMetadata struct {
	Name      string `json:"name" yaml:"name" hcl:"name"`
	Namespace string `json:"namespace" yaml:"namespace" hcl:"namespace"`
}

type MinimalK8sYaml

type MinimalK8sYaml struct {
	Kind     string             `json:"kind" yaml:"kind" hcl:"kind"`
	Metadata MinimalK8sMetadata `json:"metadata" yaml:"metadata" hcl:"metadata"`
}

type PostKustomizeFile

type PostKustomizeFile struct {
	Order   int
	Minimal MinimalK8sYaml
	Full    interface{}
}

type PostKustomizeFileCollection

type PostKustomizeFileCollection []PostKustomizeFile

func (PostKustomizeFileCollection) Len

func (c PostKustomizeFileCollection) Len() int

func (PostKustomizeFileCollection) Less

func (c PostKustomizeFileCollection) Less(i, j int) bool

func (PostKustomizeFileCollection) Swap

func (c PostKustomizeFileCollection) Swap(i, j int)