Documentation
¶
Index ¶
Constants ¶
View Source
const (
// CurrentVersion is the current API version
CurrentVersion = "v1alpha1"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definition ¶
type Definition struct {
// APIVersion is the current version of the plan format
APIVersion string `yaml:"apiVersion"`
// Kind is what type of this definition is
Kind string `yaml:"kind"`
// Metadata houses metadata about the plan
Metadata metadata `yaml:"metadata"`
// Spec contains the specification for the experiment plan
Spec declaration.Declaration `yaml:"spec"`
}
Definition wraps the entire plan, namely version info type/kind info, metadata and the experiment Spec itself
func NewDefinition ¶
func NewDefinition() Definition
NewDefinition initializes a Plan that can be used as the basis for starting a plan configuration
func ParseYAML ¶
func ParseYAML(data []byte) (*Definition, error)
ParseYAML de-serializes an experiment plan from submitted bytes
func (*Definition) ToYAML ¶
func (p *Definition) ToYAML() ([]byte, error)
ToYAML serializes a experiment plan to YAML
Source Files
Click to show internal directories.
Click to hide internal directories.