watches

Documentation

Index

• Constants
• func Append(r io.Reader, watch Watch) ([]byte, error)
• func UpdateForResource(path string, r *scaffold.Resource, chartName string) (err error)
• type Watch
  • func Load(path string) ([]Watch, error)
  • func LoadReader(reader io.Reader) ([]Watch, error)
  • func (w *Watch) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const WatchesFile = "watches.yaml"

Functions

func Append

func Append(r io.Reader, watch Watch) ([]byte, error)

Append reads watches.yaml data from the provided reader, verifies that the provided watch is valid and unique, and returns a buffer containing the new watch appended to the end of the existing watches.yaml data. If an error occurs, it will be returned.

func UpdateForResource

func UpdateForResource(path string, r *scaffold.Resource, chartName string) (err error)

UpdateForResource appends a new watch to the provided watches.yaml file based on the provided resource. The watch is validated and must be unique. If an error occurs, it is returned.

Types

type Watch

type Watch struct {
	schema.GroupVersionKind `json:",inline"`
	ChartDir                string            `json:"chart"`
	WatchDependentResources *bool             `json:"watchDependentResources,omitempty"`
	OverrideValues          map[string]string `json:"overrideValues,omitempty"`
}

Watch defines options for configuring a watch for a Helm-based custom resource.

func Load

func Load(path string) ([]Watch, error)

Load loads a slice of Watches from the watch file at `path`. For each entry in the watches file, it verifies the configuration. If an error is encountered loading the file or verifying the configuration, it will be returned.

func LoadReader

func LoadReader(reader io.Reader) ([]Watch, error)

LoadReader loads a slice of Watches from the provided reader. For each entry in the watches file, it verifies the configuration. If an error is encountered reading or verifying the configuration, it will be returned.

func (*Watch) UnmarshalYAML

func (w *Watch) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals an individual watch from the Helm watches.yaml file into a Watch struct.

Deprecated: This function is no longer used internally to unmarshal watches.yaml data. To ensure the correct defaults are applied when loading watches.yaml, use Load() or LoadReader() instead of this function and/or yaml.Unmarshal().