decoder

Documentation

Overview

Package decoder provides a YAML decoder for machine configuration documents.

Index

• Constants
• Variables
• type Decoder
  • func NewDecoder() *Decoder
  • func (d *Decoder) Decode(r io.Reader) ([]config.Document, error)

Constants

const (
	// ManifestAPIVersionKey is the string indicating a manifest's version.
	ManifestAPIVersionKey = "apiVersion"
	// ManifestKindKey is the string indicating a manifest's kind.
	ManifestKindKey = "kind"
	// ManifestDeprecatedKeyMachine represents the deprecated v1alpha1 manifest.
	ManifestDeprecatedKeyMachine = "machine"
	// ManifestDeprecatedKeyCluster represents the deprecated v1alpha1 manifest.
	ManifestDeprecatedKeyCluster = "cluster"
	// ManifestDeprecatedKeyDebug represents the deprecated v1alpha1 manifest.
	ManifestDeprecatedKeyDebug = "debug"
	// ManifestDeprecatedKeyPersist represents the deprecated v1alpha1 manifest.
	ManifestDeprecatedKeyPersist = "persist"
)

Variables

var ErrMissingKind = errors.New("missing kind")

ErrMissingKind indicates that the manifest is missing a kind.

Types

type Decoder

type Decoder struct{}

Decoder represents a multi-doc YAML decoder.

func NewDecoder

func NewDecoder() *Decoder

NewDecoder initializes and returns a `Decoder`.

func (*Decoder) Decode

func (d *Decoder) Decode(r io.Reader) ([]config.Document, error)

Decode decodes all known manifests.