towk/configurator
1
0
Fork 0
mirror of https://github.com/davidallendj/configurator.git synced 2025-12-20 03:27:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md

Browse source
This commit is contained in:
David Allen 2024-07-03 10:03:16 -06:00
parent 2b064c2700
commit 708980831b
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
1 changed files with 16 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -53,10 +53,12 @@ This will do the same thing as the `generate` subcommand, but remotely.
The `configurator` uses generator plugins to define how config files are generated using a `Generator` interface. The interface is defined like so:
```go
type Files = map[string][]byte
type Generator interface {
GetName() string
GetGroups() []string
Generate(config *configurator.Config, opts ...util.Option) ([]byte, error)
GetVersion() string
GetDescription() string
Generate(config *configurator.Config, opts ...util.Option) (Files, error)
}
```
@ -68,7 +70,17 @@ package main
type MyGenerator struct {}
func (g *MyGenerator) GetName() string {
return "my-generator"
// just an example...this can be done however you want
pluginInfo := LoadFromFile("path/to/plugin/info.json")
return pluginInfo["name"]
}
func (g *MyGenerator) GetVersion() string {
return "v1.0.0"
}
func (g *MyGenerator) GetDescription() string {
return "This is an example plugin."
}
func (g *MyGenerator) Generate(config *configurator.Config, opts ...util.Option) (map[string][]byte, error) {
@ -83,7 +95,7 @@ func (g *MyGenerator) Generate(config *configurator.Config, opts ...util.Option)
// ... blah, blah, blah, format output, and so on...
}
// apply the template and get substituted output as byte array
// apply the substitutions to Jinja template and return output as byte array
return generator.ApplyTemplate(path, generator.Mappings{
"hosts": output,
})