manifestreader

Documentation

Index

• func FilterLocalConfig(objs []*unstructured.Unstructured) []*unstructured.Unstructured
• func KyamlNodeToUnstructured(n *yaml.RNode) (*unstructured.Unstructured, error)
• func NewFakeLoader(f util.Factory, objs object.ObjMetadataSet) *fakeLoader
• func RemoveAnnotations(n *yaml.RNode, annotations ...kioutil.AnnotationKey) error
• func SetNamespaces(mapper meta.RESTMapper, objs []*unstructured.Unstructured, ...) error
• type ManifestLoader
  • func NewManifestLoader(f util.Factory) ManifestLoader
• type ManifestReader
• type NamespaceMismatchError
  • func (e *NamespaceMismatchError) Error() string
• type PathManifestReader
  • func (p *PathManifestReader) Read() ([]*unstructured.Unstructured, error)
• type ReaderOptions
• type StreamManifestReader
  • func (r *StreamManifestReader) Read() ([]*unstructured.Unstructured, error)
• type UnknownTypesError
  • func (e *UnknownTypesError) Error() string

Functions

func FilterLocalConfig

func FilterLocalConfig(objs []*unstructured.Unstructured) []*unstructured.Unstructured

FilterLocalConfig returns a new slice of Unstructured where all resources with the LocalConfig annotation is filtered out.

func KyamlNodeToUnstructured

func KyamlNodeToUnstructured(n *yaml.RNode) (*unstructured.Unstructured, error)

KyamlNodeToUnstructured take a resource represented as a kyaml RNode and turns it into an Unstructured object.

func NewFakeLoader

func NewFakeLoader(f util.Factory, objs object.ObjMetadataSet) *fakeLoader

func RemoveAnnotations

func RemoveAnnotations(n *yaml.RNode, annotations ...kioutil.AnnotationKey) error

RemoveAnnotations removes the specified kioutil annotations from the resource.

func SetNamespaces

func SetNamespaces(mapper meta.RESTMapper, objs []*unstructured.Unstructured,
	defaultNamespace string, enforceNamespace bool) error

SetNamespaces verifies that every namespaced resource has the namespace set, and if one does not, it will set the namespace to the provided defaultNamespace. This implementation will check each resource (that doesn't already have the namespace set) on whether it is namespace or cluster scoped. It does this by first checking the RESTMapper, and it there is not match there, it will look for CRDs in the provided Unstructureds.

Types

type ManifestLoader

type ManifestLoader interface {
	InventoryInfo([]*unstructured.Unstructured) (inventory.InventoryInfo, []*unstructured.Unstructured, error)
	ManifestReader(reader io.Reader, path string) (ManifestReader, error)
}

ManifestLoader is an interface for reading and parsing the resources and inventory info.

func NewManifestLoader

func NewManifestLoader(f util.Factory) ManifestLoader

NewManifestLoader returns an instance of manifestLoader.

type ManifestReader

type ManifestReader interface {
	Read() ([]*unstructured.Unstructured, error)
}

ManifestReader defines the interface for reading a set of manifests into info objects.

type NamespaceMismatchError

type NamespaceMismatchError struct {
	RequiredNamespace string
	Namespace         string
}

NamespaceMismatchError is returned if all resources must be in a specific namespace, and resources are found using other namespaces.

func (*NamespaceMismatchError) Error

func (e *NamespaceMismatchError) Error() string

type PathManifestReader

type PathManifestReader struct {
	Path string

	ReaderOptions
}

PathManifestReader reads manifests from the provided path and returns them as Info objects. The returned Infos will not have client or mapping set.

func (*PathManifestReader) Read

func (p *PathManifestReader) Read() ([]*unstructured.Unstructured, error)

Read reads the manifests and returns them as Info objects.

type ReaderOptions

type ReaderOptions struct {
	Mapper           meta.RESTMapper
	Validate         bool
	Namespace        string
	EnforceNamespace bool
}

ReaderOptions defines the shared inputs for the different implementations of the ManifestReader interface.

type StreamManifestReader

type StreamManifestReader struct {
	ReaderName string
	Reader     io.Reader

	ReaderOptions
}

StreamManifestReader reads manifest from the provided io.Reader and returns them as Info objects. The returned Infos will not have client or mapping set.

func (*StreamManifestReader) Read

func (r *StreamManifestReader) Read() ([]*unstructured.Unstructured, error)

Read reads the manifests and returns them as Info objects.

type UnknownTypesError

type UnknownTypesError struct {
	GroupKinds []schema.GroupKind
}

UnknownTypesError captures information about unknown types encountered.

func (*UnknownTypesError) Error

func (e *UnknownTypesError) Error() string