resource

Documentation

Index

• func FromFiles(ctx context.Context, paths []string, ignoreFilePatterns []string) (<-chan Resource, <-chan error)
• func FromStream(ctx context.Context, path string, r io.Reader) (<-chan Resource, <-chan error)
• func SplitYAMLDocument(data []byte, atEOF bool) (advance int, token []byte, err error)
• type DiscoveryError
  • func (de DiscoveryError) Error() string
• type Resource
  • func (res *Resource) Resources() []Resource
  • func (res *Resource) Signature() (*Signature, error)
  • func (res *Resource) SignatureFromMap(m map[string]interface{}) (*Signature, error)
• type Signature
  • func (sig *Signature) GroupVersionKind() string
  • func (sig *Signature) QualifiedName() string

Functions

func FromFiles

func FromFiles(ctx context.Context, paths []string, ignoreFilePatterns []string) (<-chan Resource, <-chan error)

func FromStream

func FromStream(ctx context.Context, path string, r io.Reader) (<-chan Resource, <-chan error)

FromStream reads resources from a byte stream, usually here stdin

func SplitYAMLDocument

func SplitYAMLDocument(data []byte, atEOF bool) (advance int, token []byte, err error)

SplitYAMLDocument is a bufio.SplitFunc for splitting a YAML document into individual documents.

This is from Kubernetes' 'pkg/util/yaml'.splitYAMLDocument, which is unfortunately not exported.

Types

type DiscoveryError

type DiscoveryError struct {
	Path string
	Err  error
}

func (DiscoveryError) Error

func (de DiscoveryError) Error() string

type Resource

type Resource struct {
	Path  string
	Bytes []byte
	// contains filtered or unexported fields
}

Resource represents a Kubernetes resource within a file

func (*Resource) Resources

func (res *Resource) Resources() []Resource

Resources returns a list of resources if the resource is of type List, a single resource otherwise See https://github.com/yannh/kubeconform/issues/53

func (*Resource) Signature

func (res *Resource) Signature() (*Signature, error)

Signature computes a signature for a resource, based on its Kind, Version, Namespace & Name

func (*Resource) SignatureFromMap

func (res *Resource) SignatureFromMap(m map[string]interface{}) (*Signature, error)

type Signature

type Signature struct {
	Kind, Version, Namespace, Name string
}

Signature is a key representing a Kubernetes resource

func (*Signature) GroupVersionKind

func (sig *Signature) GroupVersionKind() string

GroupVersionKind returns a string with the GVK encoding of a resource signature. This encoding slightly differs from the Kubernetes upstream implementation in order to be suitable for being used in the kubeconform command-line arguments.

func (*Signature) QualifiedName

func (sig *Signature) QualifiedName() string

QualifiedName returns a string for a signature in the format version/kind/namespace/name