spec

Documentation

Index

• Constants
• func Parse(data []byte, namespace string) (*v1alpha1.Environment, error)
• func ParseDir(path string) (*v1alpha1.Environment, error)
• type ErrDeprecated
  • func (e ErrDeprecated) Error() string
• type ErrMistypedField
  • func (e ErrMistypedField) Error() string
• type ErrNoSpec
  • func (e ErrNoSpec) Error() string

Constants

const APIGroup = "tanka.dev"

APIGroup is the prefix used for `kind`

const Specfile = "spec.json"

Specfile is the filename for the environment config

Functions

func Parse

func Parse(data []byte, namespace string) (*v1alpha1.Environment, error)

Parse parses the json `data` into a `v1alpha1.Environment` object.

func ParseDir

func ParseDir(path string) (*v1alpha1.Environment, error)

ParseDir parses the given environments `spec.json` into a `v1alpha1.Environment` object with the name set to the directories name

Types

type ErrDeprecated

type ErrDeprecated []depreciation

ErrDeprecated is a non-fatal error that occurs when deprecated fields are used in the spec.json

func (ErrDeprecated) Error

func (e ErrDeprecated) Error() string

type ErrMistypedField

type ErrMistypedField struct {
	// contains filtered or unexported fields
}

ErrMistypedField occurs that the field of the given name has the wrong type

func (ErrMistypedField) Error

func (e ErrMistypedField) Error() string

type ErrNoSpec

type ErrNoSpec struct {
	// contains filtered or unexported fields
}

ErrNoSpec means that the given directory has no spec.json This must not be fatal, some operations work without

func (ErrNoSpec) Error

func (e ErrNoSpec) Error() string