puppet

Documentation

Overview

Package puppet provides the integration entrypoint for the puppet language.

Index

• Constants
• type GAPI
  • func (obj *GAPI) Cli(c *cli.Context, fs resources.Fs) (*gapi.Deploy, error)
  • func (obj *GAPI) CliFlags() []cli.Flag
  • func (obj *GAPI) Close() error
  • func (obj *GAPI) Graph() (*pgraph.Graph, error)
  • func (obj *GAPI) Init(data gapi.Data) error
  • func (obj *GAPI) Next() chan gapi.Next
  • func (obj *GAPI) ParseConfigFromPuppet() *yamlgraph.GraphConfig

Constants

const (
	// Name is the name of this frontend.
	Name = "puppet"
	// PuppetFile is the entry point filename that we use. It is arbitrary.
	PuppetFile = "/file.pp"
	// PuppetConf is the entry point config filename that we use.
	PuppetConf = "/puppet.conf"
	// PuppetSite is the entry point folder that we use.
	PuppetSite = "/puppet/"
)

const (
	// PuppetYAMLBufferSize is the maximum buffer size for the yaml input data
	PuppetYAMLBufferSize = 65535
	// Debug is a local debug constant used in this module
	Debug = false // FIXME: integrate with global debug flag
)

Types

type GAPI

type GAPI struct {
	InputURI string
	Mode     string // agent, file, string, dir
	// contains filtered or unexported fields
}

GAPI implements the main puppet GAPI interface.

func (*GAPI) Cli

func (obj *GAPI) Cli(c *cli.Context, fs resources.Fs) (*gapi.Deploy, error)

Cli takes a cli.Context, and returns our GAPI if activated. All arguments should take the prefix of the registered name. On activation, if there are any validation problems, you should return an error. If this was not activated, then you should return a nil GAPI and a nil error.

func (*GAPI) CliFlags

func (obj *GAPI) CliFlags() []cli.Flag

CliFlags returns a list of flags used by this deploy subcommand.

func (*GAPI) Close

func (obj *GAPI) Close() error

Close shuts down the Puppet GAPI.

func (*GAPI) Graph

func (obj *GAPI) Graph() (*pgraph.Graph, error)

Graph returns a current Graph.

func (*GAPI) Init

func (obj *GAPI) Init(data gapi.Data) error

Init initializes the puppet GAPI struct.

func (*GAPI) Next

func (obj *GAPI) Next() chan gapi.Next

Next returns nil errors every time there could be a new graph.

func (*GAPI) ParseConfigFromPuppet

func (obj *GAPI) ParseConfigFromPuppet() *yamlgraph.GraphConfig

ParseConfigFromPuppet returns the graph configuration structure from the mode and input values, including possibly some file and directory paths.