This is a new design idea which I had. Whether it stays around or not is up for debate. For now it's a rough POC. The idea is that any resource can _produce_ data, and any resource can _consume_ data. This is what we call send and recv. By linking the two together, data can be passed directly between resources, which will maximize code re-use, and allow for some interesting logical graphs. For example, you might have an HTTP resource which puts its output in a particular file. This avoids having to overload the HTTP resource with all of the special behaviours of the File resource. For our POC, I implemented a `password` resource which generates a random string which can then be passed to a receiver such as a file. At this point the password resource isn't recommended for sensitive applications because it caches the password as plain text. Still to do: * Statically check all of the type matching before we run the graph * Verify that our autogrouping works correctly around this feature * Verify that appropriate edges exist between send->recv pairs * Label the password as generated instead of storing the plain text * Consider moving password logic from Init() to CheckApply() * Consider combining multiple send values (list?) into a single receiver * Consider intermediary transformation nodes for value combining
193 lines
4.2 KiB
Go
193 lines
4.2 KiB
Go
// libmgmt example of send->recv
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"os/signal"
|
|
"sync"
|
|
"syscall"
|
|
"time"
|
|
|
|
"github.com/purpleidea/mgmt/gapi"
|
|
mgmt "github.com/purpleidea/mgmt/mgmtmain"
|
|
"github.com/purpleidea/mgmt/pgraph"
|
|
"github.com/purpleidea/mgmt/resources"
|
|
)
|
|
|
|
// MyGAPI implements the main GAPI interface.
|
|
type MyGAPI struct {
|
|
Name string // graph name
|
|
Interval uint // refresh interval, 0 to never refresh
|
|
|
|
data gapi.Data
|
|
initialized bool
|
|
closeChan chan struct{}
|
|
wg sync.WaitGroup // sync group for tunnel go routines
|
|
}
|
|
|
|
// NewMyGAPI creates a new MyGAPI struct and calls Init().
|
|
func NewMyGAPI(data gapi.Data, name string, interval uint) (*MyGAPI, error) {
|
|
obj := &MyGAPI{
|
|
Name: name,
|
|
Interval: interval,
|
|
}
|
|
return obj, obj.Init(data)
|
|
}
|
|
|
|
// Init initializes the MyGAPI struct.
|
|
func (obj *MyGAPI) Init(data gapi.Data) error {
|
|
if obj.initialized {
|
|
return fmt.Errorf("Already initialized!")
|
|
}
|
|
if obj.Name == "" {
|
|
return fmt.Errorf("The graph name must be specified!")
|
|
}
|
|
obj.data = data // store for later
|
|
obj.closeChan = make(chan struct{})
|
|
obj.initialized = true
|
|
return nil
|
|
}
|
|
|
|
// Graph returns a current Graph.
|
|
func (obj *MyGAPI) Graph() (*pgraph.Graph, error) {
|
|
if !obj.initialized {
|
|
return nil, fmt.Errorf("libmgmt: MyGAPI is not initialized")
|
|
}
|
|
|
|
g := pgraph.NewGraph(obj.Name)
|
|
|
|
p1 := &resources.PasswordRes{
|
|
BaseRes: resources.BaseRes{
|
|
Name: "password1",
|
|
},
|
|
Length: 8, // generated string will have this many characters
|
|
}
|
|
v1 := pgraph.NewVertex(p1)
|
|
g.AddVertex(v1)
|
|
|
|
f1 := &resources.FileRes{
|
|
BaseRes: resources.BaseRes{
|
|
Name: "file1",
|
|
// send->recv!
|
|
Recv: map[string]resources.Send{
|
|
"Content": resources.Send{Res: p1, Key: "Password"},
|
|
},
|
|
},
|
|
Path: "/tmp/mgmt/f1",
|
|
//Content: p1.Password, // won't work
|
|
State: "present",
|
|
}
|
|
|
|
v2 := pgraph.NewVertex(f1)
|
|
g.AddVertex(v2)
|
|
|
|
g.AddEdge(v1, v2, pgraph.NewEdge("e1"))
|
|
|
|
//g, err := config.NewGraphFromConfig(obj.data.Hostname, obj.data.EmbdEtcd, obj.data.Noop)
|
|
return g, nil
|
|
}
|
|
|
|
// SwitchStream returns nil errors every time there could be a new graph.
|
|
func (obj *MyGAPI) SwitchStream() chan error {
|
|
if obj.data.NoWatch || obj.Interval <= 0 {
|
|
return nil
|
|
}
|
|
ch := make(chan error)
|
|
obj.wg.Add(1)
|
|
go func() {
|
|
defer obj.wg.Done()
|
|
defer close(ch) // this will run before the obj.wg.Done()
|
|
if !obj.initialized {
|
|
ch <- fmt.Errorf("libmgmt: MyGAPI is not initialized")
|
|
return
|
|
}
|
|
|
|
// arbitrarily change graph every interval seconds
|
|
ticker := time.NewTicker(time.Duration(obj.Interval) * time.Second)
|
|
defer ticker.Stop()
|
|
for {
|
|
select {
|
|
case <-ticker.C:
|
|
log.Printf("libmgmt: Generating new graph...")
|
|
ch <- nil // trigger a run
|
|
case <-obj.closeChan:
|
|
return
|
|
}
|
|
}
|
|
}()
|
|
return ch
|
|
}
|
|
|
|
// Close shuts down the MyGAPI.
|
|
func (obj *MyGAPI) Close() error {
|
|
if !obj.initialized {
|
|
return fmt.Errorf("libmgmt: MyGAPI is not initialized")
|
|
}
|
|
close(obj.closeChan)
|
|
obj.wg.Wait()
|
|
obj.initialized = false // closed = true
|
|
return nil
|
|
}
|
|
|
|
// Run runs an embedded mgmt server.
|
|
func Run() error {
|
|
|
|
obj := &mgmt.Main{}
|
|
obj.Program = "libmgmt" // TODO: set on compilation
|
|
obj.Version = "0.0.1" // TODO: set on compilation
|
|
obj.TmpPrefix = true
|
|
obj.IdealClusterSize = -1
|
|
obj.ConvergedTimeout = -1
|
|
obj.Noop = false // FIXME: careful!
|
|
|
|
obj.GAPI = &MyGAPI{ // graph API
|
|
Name: "libmgmt", // TODO: set on compilation
|
|
Interval: 60 * 10, // arbitrarily change graph every 15 seconds
|
|
}
|
|
|
|
if err := obj.Init(); err != nil {
|
|
return err
|
|
}
|
|
|
|
// install the exit signal handler
|
|
exit := make(chan struct{})
|
|
defer close(exit)
|
|
go func() {
|
|
signals := make(chan os.Signal, 1)
|
|
signal.Notify(signals, os.Interrupt) // catch ^C
|
|
//signal.Notify(signals, os.Kill) // catch signals
|
|
signal.Notify(signals, syscall.SIGTERM)
|
|
|
|
select {
|
|
case sig := <-signals: // any signal will do
|
|
if sig == os.Interrupt {
|
|
log.Println("Interrupted by ^C")
|
|
obj.Exit(nil)
|
|
return
|
|
}
|
|
log.Println("Interrupted by signal")
|
|
obj.Exit(fmt.Errorf("Killed by %v", sig))
|
|
return
|
|
case <-exit:
|
|
return
|
|
}
|
|
}()
|
|
|
|
if err := obj.Run(); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func main() {
|
|
log.Printf("Hello!")
|
|
if err := Run(); err != nil {
|
|
fmt.Println(err)
|
|
os.Exit(1)
|
|
return
|
|
}
|
|
log.Printf("Goodbye!")
|
|
}
|