utils

Documentation

Index

• func Apply(ctx context.Context, rcg genericclioptions.RESTClientGetter, ...) (string, error)
• func CompatibleVersion(binary, target string) bool
• func ContainsEqualFoldItemString(s []string, e string) (string, bool)
• func ContainsItemString(s []string, e string) bool
• func ExecKubectlCommand(ctx context.Context, mode ExecMode, kubeConfigPath string, kubeContext string, ...) (string, error)
• func ExtractCRDs(inManifestPath, outManifestPath string) error
• func IsAPINamespaced(obj runtime.Object, scheme *runtime.Scheme, restmapper apimeta.RESTMapper) (bool, error)
• func IsAPINamespacedWithGVK(gk schema.GroupVersionKind, scheme *runtime.Scheme, ...) (bool, error)
• func KubeClient(rcg genericclioptions.RESTClientGetter, opts *runclient.Options) (client.WithWatch, error)
• func KubeConfig(rcg genericclioptions.RESTClientGetter, opts *runclient.Options) (*rest.Config, error)
• func MakeDependsOn(deps []string) []meta.NamespacedObjectReference
• func NewScheme() *apiruntime.Scheme
• func ParseNamespacedName(input string) types.NamespacedName
• func ParseObjectKindName(input string) (kind, name string)
• func ParseObjectKindNameNamespace(input string) (kind, name, namespace string)
• func SplitKubeConfigPath(path string) []string
• func TruncateHex(str string) string
• func ValidateComponents(components []string) error
• type ExecMode

Functions

func Apply

func Apply(ctx context.Context, rcg genericclioptions.RESTClientGetter, opts *runclient.Options, root, manifestPath string) (string, error)

Apply is the equivalent of 'kubectl apply --server-side -f'. If the given manifest is a kustomization.yaml, then apply performs the equivalent of 'kubectl apply --server-side -k'.

func CompatibleVersion

func CompatibleVersion(binary, target string) bool

CompatibleVersion returns if the provided binary version is compatible with the given target version. At present, this is true if the target version is equal to the MINOR range of the binary, or if the binary version is a prerelease.

func ContainsEqualFoldItemString

func ContainsEqualFoldItemString(s []string, e string) (string, bool)

func ContainsItemString

func ContainsItemString(s []string, e string) bool

func ExecKubectlCommand

func ExecKubectlCommand(ctx context.Context, mode ExecMode, kubeConfigPath string, kubeContext string, args ...string) (string, error)

func ExtractCRDs

func ExtractCRDs(inManifestPath, outManifestPath string) error

func IsAPINamespaced

func IsAPINamespaced(obj runtime.Object, scheme *runtime.Scheme, restmapper apimeta.RESTMapper) (bool, error)

IsAPINamespaced returns true if the object is namespace scoped. For unstructured objects the gvk is found from the object itself.

func IsAPINamespacedWithGVK

func IsAPINamespacedWithGVK(gk schema.GroupVersionKind, scheme *runtime.Scheme, restmapper apimeta.RESTMapper) (bool, error)

IsAPINamespacedWithGVK returns true if the object having the provided GVK is namespace scoped.

func KubeClient

func KubeClient(rcg genericclioptions.RESTClientGetter, opts *runclient.Options) (client.WithWatch, error)

func KubeConfig

func KubeConfig(rcg genericclioptions.RESTClientGetter, opts *runclient.Options) (*rest.Config, error)

func MakeDependsOn

func MakeDependsOn(deps []string) []meta.NamespacedObjectReference

func NewScheme

func NewScheme() *apiruntime.Scheme

Create the Scheme, methods for serializing and deserializing API objects which can be shared by tests.

func ParseNamespacedName

func ParseNamespacedName(input string) types.NamespacedName

ParseNamespacedName extracts the NamespacedName of a resource based on the '<namespace>/<name>' format

func ParseObjectKindName

func ParseObjectKindName(input string) (kind, name string)

ParseObjectKindName extracts the kind and name of a resource based on the '<kind>/<name>' format

func ParseObjectKindNameNamespace

func ParseObjectKindNameNamespace(input string) (kind, name, namespace string)

ParseObjectKindNameNamespace extracts the kind, name and namespace of a resource based on the '<kind>/<name>.<namespace>' format

func SplitKubeConfigPath

func SplitKubeConfigPath(path string) []string

SplitKubeConfigPath splits the given KUBECONFIG path based on the runtime OS target.

Ref: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable

func TruncateHex

func TruncateHex(str string) string

TruncateHex will replace any hexadecimal notation between 40 and 128 characters (SHA-1 up to SHA-512) within the given string with a truncated version of 8 characters.

func ValidateComponents

func ValidateComponents(components []string) error

Types

type ExecMode

type ExecMode string

const (
	ModeOS       ExecMode = "os.stderr|stdout"
	ModeStderrOS ExecMode = "os.stderr"
	ModeCapture  ExecMode = "capture.stderr|stdout"
)