resources

type AugeasRes struct {
	traits.Base // add the base methods without re-implementation

	// File is the path to the file targeted by this resource.
	File string `yaml:"file"`

	// Lens is the lens used by this resource. If specified, mgmt
	// will lower the augeas overhead by only loading that lens.
	Lens string `yaml:"lens"`

	// Sets is a list of changes that will be applied to the file, in the form of
	// ["path", "value"]. mgmt will run augeas.Get() before augeas.Set(), to
	// prevent changing the file when it is not needed.
	Sets []*AugeasSet `yaml:"sets"`
	// contains filtered or unexported fields
}

type AugeasSet struct {
	Path  string `yaml:"path"`  // The relative path to the value to be changed.
	Value string `yaml:"value"` // The value to be set on the given Path.
}

type AugeasUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type AwsEc2Res struct {
	traits.Base // add the base methods without re-implementation

	State   string `yaml:"state"`   // state: running, stopped, terminated
	Region  string `yaml:"region"`  // region must match an element of AwsRegions
	Type    string `yaml:"type"`    // type of ec2 instance, eg: t2.micro
	ImageID string `yaml:"imageid"` // imageid must be available on the chosen region

	WatchEndpoint   string `yaml:"watchendpoint"`   // the public url of the sns endpoint, eg: http://server:12345/
	WatchListenAddr string `yaml:"watchlistenaddr"` // the local address or port that the sns listens on, eg: 10.0.0.0:23456 or 23456
	// ErrorOnMalformedPost controls whether or not malformed HTTP post
	// requests, that cause JSON decoder errors, will also make the engine
	// shut down. If ErrorOnMalformedPost set to true and an error occurs,
	// Watch() will return the error and the engine will shut down.
	ErrorOnMalformedPost bool `yaml:"erroronmalformedpost"`

	// UserData is used to run bash and cloud-init commands on first launch.
	// See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html
	// for documantation and examples.
	UserData string `yaml:"userdata"`

	// store read-only values for send/recv.
	PublicIPv4  string
	PrivateIPv4 string
	InstanceID  string
	// contains filtered or unexported fields
}

type AwsEc2UID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type ExecRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Edgeable

	Cmd        string  `yaml:"cmd"`        // the command to run
	Shell      string  `yaml:"shell"`      // the (optional) shell to use to run the cmd
	Timeout    int     `yaml:"timeout"`    // the cmd timeout in seconds
	WatchCmd   string  `yaml:"watchcmd"`   // the watch command to run
	WatchShell string  `yaml:"watchshell"` // the (optional) shell to use to run the watch cmd
	IfCmd      string  `yaml:"ifcmd"`      // the if command to run
	IfShell    string  `yaml:"ifshell"`    // the (optional) shell to use to run the if cmd
	User       string  `yaml:"user"`       // the (optional) user to use to execute the command
	Group      string  `yaml:"group"`      // the (optional) group to use to execute the command
	Output     *string // all cmd output, read only, do not set!
	Stdout     *string // the cmd stdout, read only, do not set!
	Stderr     *string // the cmd stderr, read only, do not set!
	// contains filtered or unexported fields
}

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

type ExecUID struct {
	engine.BaseUID
	Cmd   string
	IfCmd string
}

type FileInfo struct {
	os.FileInfo        // embed
	AbsPath     string // smart variant
	RelPath     string // smart variant
}

type FileRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Edgeable
	//traits.Groupable // TODO: implement this
	traits.Recvable

	Path     string  `yaml:"path"`     // path variable (usually defaults to name)
	Dirname  string  `yaml:"dirname"`  // override the path dirname
	Basename string  `yaml:"basename"` // override the path basename
	Content  *string `yaml:"content"`  // nil to mark as undefined
	Source   string  `yaml:"source"`   // file path for source content
	State    string  `yaml:"state"`    // state: exists/present?, absent, (undefined?)
	Owner    string  `yaml:"owner"`
	Group    string  `yaml:"group"`
	Mode     string  `yaml:"mode"`
	Recurse  bool    `yaml:"recurse"`
	Force    bool    `yaml:"force"`
	// contains filtered or unexported fields
}

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

type FileUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type GroupRes struct {
	traits.Base // add the base methods without re-implementation

	State string  `yaml:"state"` // state: exists, absent
	GID   *uint32 `yaml:"gid"`   // the group's gid
	// contains filtered or unexported fields
}

type GroupUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type HostnameRes struct {
	traits.Base // add the base methods without re-implementation

	Hostname          string `yaml:"hostname"`
	PrettyHostname    string `yaml:"pretty_hostname"`
	StaticHostname    string `yaml:"static_hostname"`
	TransientHostname string `yaml:"transient_hostname"`
	// contains filtered or unexported fields
}

type HostnameUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type KVRes struct {
	traits.Base // add the base methods without re-implementation
	//traits.Groupable // TODO: it could be useful to group our writes and watches!
	traits.Refreshable
	traits.Recvable

	// XXX: shouldn't the name be the key?
	Key          string            `yaml:"key"`          // key to set
	Value        *string           `yaml:"value"`        // value to set (nil to delete)
	SkipLessThan bool              `yaml:"skiplessthan"` // skip updates as long as stored value is greater
	SkipCmpStyle KVResSkipCmpStyle `yaml:"skipcmpstyle"` // how to do the less than cmp
	// contains filtered or unexported fields
}

type KVResSkipCmpStyle int

type KVUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type MountRes struct {
	traits.Base

	// State must be exists ot absent. If absent, remaining fields are ignored.
	State   string            `yaml:"state"`
	Device  string            `yaml:"device"`  // location of the device or image
	Type    string            `yaml:"type"`    // the type of filesystem
	Options map[string]string `yaml:"options"` // mount options
	Freq    int               `yaml:"freq"`    // dump frequency
	PassNo  int               `yaml:"passno"`  // verification order
	// contains filtered or unexported fields
}

type MountUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type MsgRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Refreshable

	Body     string            `yaml:"body"`
	Priority string            `yaml:"priority"`
	Fields   map[string]string `yaml:"fields"`
	Journal  bool              `yaml:"journal"` // enable systemd journal output
	Syslog   bool              `yaml:"syslog"`  // enable syslog output
	// contains filtered or unexported fields
}

type MsgUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type NetRes struct {
	traits.Base // add the base methods without re-implementation

	State   string   `yaml:"state"`   // up, down, or empty
	Addrs   []string `yaml:"addrs"`   // list of addresses in cidr format
	Gateway string   `yaml:"gateway"` // gateway address
	// contains filtered or unexported fields
}

type NetUID struct {
	// NOTE: There is also a name variable in the BaseUID struct, this is
	// information about where this UID came from, and is unrelated to the
	// information about the resource we're matching. That data which is
	// used in the IFF function, is what you see in the struct fields here.
	engine.BaseUID
	// contains filtered or unexported fields
}

type NoopRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Groupable
	traits.Refreshable

	Comment string `lang:"comment" yaml:"comment"` // extra field for example purposes
	// contains filtered or unexported fields
}

type NoopUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type NspawnRes struct {
	traits.Base // add the base methods without re-implementation

	State string `yaml:"state"`
	// contains filtered or unexported fields
}

type NspawnUID struct {
	// NOTE: There is also a name variable in the BaseUID struct, this is
	// information about where this UID came from, and is unrelated to the
	// information about the resource we're matching. That data which is
	// used in the IFF function, is what you see in the struct fields here.
	engine.BaseUID
	// contains filtered or unexported fields
}

type PasswordRes struct {
	traits.Base // add the base methods without re-implementation
	// TODO: it could be useful to group our tokens into a single write, and
	// as a result, we save inotify watches too!
	//traits.Groupable // TODO: this is doable, but probably not very useful
	traits.Refreshable
	traits.Sendable

	// FIXME: is uint16 too big?
	Length        uint16 `yaml:"length"` // number of characters to return
	Saved         bool   // this caches the password in the clear locally
	CheckRecovery bool   // recovery from integrity checks by re-generating
	// contains filtered or unexported fields
}

type PasswordSends struct {
	// Password is the generated password being sent.
	Password *string
	// Hashing is the algorithm used for this password. Empty is plain text.
	Hashing string // TODO: implement me
}

type PasswordUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type PkgFileUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type PkgRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Edgeable
	traits.Groupable

	State            string `yaml:"state"`            // state: installed, uninstalled, newest, <version>
	AllowUntrusted   bool   `yaml:"allowuntrusted"`   // allow untrusted packages to be installed?
	AllowNonFree     bool   `yaml:"allownonfree"`     // allow nonfree packages to be found?
	AllowUnsupported bool   `yaml:"allowunsupported"` // allow unsupported packages to be found?
	// contains filtered or unexported fields
}

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

type PkgUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type PrintRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Groupable
	traits.Recvable
	traits.Refreshable

	Msg string `lang:"msg" yaml:"msg"` // the message to display
	// contains filtered or unexported fields
}

type PrintUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type SvcRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Edgeable
	traits.Groupable
	traits.Refreshable

	State   string `yaml:"state"`   // state: running, stopped, undefined
	Startup string `yaml:"startup"` // enabled, disabled, undefined
	Session bool   `yaml:"session"` // user session (true) or system?
	// contains filtered or unexported fields
}

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

type SvcUID struct {
	// NOTE: there is also a name variable in the BaseUID struct, this is
	// information about where this UID came from, and is unrelated to the
	// information about the resource we're matching. That data which is
	// used in the IFF function, is what you see in the struct fields here.
	engine.BaseUID
	// contains filtered or unexported fields
}

type TestRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Groupable
	traits.Refreshable
	traits.Sendable
	traits.Recvable

	Bool bool   `lang:"bool" yaml:"bool"`
	Str  string `lang:"str" yaml:"str"` // can't name it String because of String()

	Int   int   `lang:"int" yaml:"int"`
	Int8  int8  `lang:"int8" yaml:"int8"`
	Int16 int16 `lang:"int16" yaml:"int16"`
	Int32 int32 `lang:"int32" yaml:"int32"`
	Int64 int64 `lang:"int64" yaml:"int64"`

	Uint   uint   `lang:"uint" yaml:"uint"`
	Uint8  uint8  `lang:"uint8" yaml:"uint8"`
	Uint16 uint16 `lang:"uint16" yaml:"uint16"`
	Uint32 uint32 `lang:"uint32" yaml:"uint32"`
	Uint64 uint64 `lang:"uint64" yaml:"uint64"`

	//Uintptr uintptr `yaml:"uintptr"`
	Byte byte `lang:"byte" yaml:"byte"` // alias for uint8
	Rune rune `lang:"rune" yaml:"rune"` // alias for int32, represents a Unicode code point

	Float32    float32    `lang:"float32" yaml:"float32"`
	Float64    float64    `lang:"float64" yaml:"float64"`
	Complex64  complex64  `lang:"complex64" yaml:"complex64"`
	Complex128 complex128 `lang:"complex128" yaml:"complex128"`

	BoolPtr   *bool   `lang:"boolptr" yaml:"bool_ptr"`
	StringPtr *string `lang:"stringptr" yaml:"string_ptr"` // TODO: tag name?
	Int64Ptr  *int64  `lang:"int64ptr" yaml:"int64ptr"`
	Int8Ptr   *int8   `lang:"int8ptr" yaml:"int8ptr"`
	Uint8Ptr  *uint8  `lang:"uint8ptr" yaml:"uint8ptr"`

	// probably makes no sense, but is legal
	Int8PtrPtrPtr ***int8 `lang:"int8ptrptrptr" yaml:"int8ptrptrptr"`

	SliceString []string          `lang:"slicestring" yaml:"slicestring"`
	MapIntFloat map[int64]float64 `lang:"mapintfloat" yaml:"mapintfloat"`
	MixedStruct struct {
		// contains filtered or unexported fields
	} `lang:"mixedstruct" yaml:"mixedstruct"`
	Interface interface{} `lang:"interface" yaml:"interface"`

	AnotherStr string `lang:"anotherstr" yaml:"anotherstr"`

	ValidateBool  bool   `lang:"validatebool" yaml:"validate_bool"`   // set to true to cause a validate error
	ValidateError string `lang:"validateerror" yaml:"validate_error"` // set to cause a validate error
	AlwaysGroup   bool   `lang:"alwaysgroup" yaml:"always_group"`     // set to true to cause auto grouping
	CompareFail   bool   `lang:"comparefail" yaml:"compare_fail"`     // will compare fail?
	SendValue     string `lang:"sendvalue" yaml:"send_value"`         // what value should we send?

	Comment string `lang:"comment" yaml:"comment"`
	// contains filtered or unexported fields
}

type TestSends struct {
	// Hello is some value being sent.
	Hello  *string
	Answer int // some other value being sent
}

type TestUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type TimerRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Refreshable

	Interval uint32 `yaml:"interval"` // interval between runs in seconds
	// contains filtered or unexported fields
}

type TimerUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type UserRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Edgeable

	State             string   `yaml:"state"`             // state: exists, absent
	UID               *uint32  `yaml:"uid"`               // uid must be unique unless AllowDuplicateUID is true
	GID               *uint32  `yaml:"gid"`               // gid of the user's primary group
	Group             *string  `yaml:"group"`             // name of the user's primary group
	Groups            []string `yaml:"groups"`            // list of supplemental groups
	HomeDir           *string  `yaml:"homedir"`           // path to the user's home directory
	AllowDuplicateUID bool     `yaml:"allowduplicateuid"` // allow duplicate uid
	// contains filtered or unexported fields
}

type UserResAutoEdges struct {
	UIDs []engine.ResUID
	// contains filtered or unexported fields
}

type UserUID struct {
	engine.BaseUID
	// contains filtered or unexported fields
}

type VirtAuth struct {
	Username string `yaml:"username"`
	Password string `yaml:"password"`
}

type VirtRes struct {
	traits.Base // add the base methods without re-implementation
	traits.Refreshable

	URI        string             `yaml:"uri"`       // connection uri, eg: qemu:///session
	State      string             `yaml:"state"`     // running, paused, shutoff
	Transient  bool               `yaml:"transient"` // defined (false) or undefined (true)
	CPUs       uint               `yaml:"cpus"`
	MaxCPUs    uint               `yaml:"maxcpus"`
	Memory     uint64             `yaml:"memory"` // in KBytes
	OSInit     string             `yaml:"osinit"` // init used by lxc
	Boot       []string           `yaml:"boot"`   // boot order. values: fd, hd, cdrom, network
	Disk       []diskDevice       `yaml:"disk"`
	CDRom      []cdRomDevice      `yaml:"cdrom"`
	Network    []networkDevice    `yaml:"network"`
	Filesystem []filesystemDevice `yaml:"filesystem"`
	Auth       *VirtAuth          `yaml:"auth"`

	HotCPUs bool `yaml:"hotcpus"` // allow hotplug of cpus?
	// FIXME: values here should be enum's!
	RestartOnDiverge string `yaml:"restartondiverge"` // restart policy: "ignore", "ifneeded", "error"
	RestartOnRefresh bool   `yaml:"restartonrefresh"` // restart on refresh?
	// contains filtered or unexported fields
}

type VirtUID struct {
	engine.BaseUID
}