package puppet

import "github.com/purpleidea/mgmt/puppet"

Package puppet provides the integration entrypoint for the puppet language.

Index ¶

• Constants
• type GAPI
• func (obj *GAPI) Cli(info *gapi.Info) (*gapi.Deploy, error)
• func (obj *GAPI) Close() error
• func (obj *GAPI) Graph() (*pgraph.Graph, error)
• func (obj *GAPI) Info() *gapi.InfoResult
• func (obj *GAPI) Init(data *gapi.Data) error
• func (obj *GAPI) Next() chan gapi.Next
• func (obj *GAPI) ParseConfigFromPuppet() (*yamlgraph.GraphConfig, error)

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. It is arbitrary.
	PuppetSite = "/puppet/"
)

const (
	// PuppetYAMLBufferSize is the maximum buffer size for the yaml input data
	PuppetYAMLBufferSize = 65535
)

Types ¶

type GAPI ¶

type GAPI struct {
	InputURI string

	// Mode of operation can be: agent, file, string, dir.
	Mode string
	// contains filtered or unexported fields
}

GAPI implements the main puppet GAPI interface.

func (*GAPI) Cli ¶

func (obj *GAPI) Cli(info *gapi.Info) (*gapi.Deploy, error)

Cli takes an *Info struct, and returns our deploy if activated, and if there are any validation problems, you should return an error. If there is no deploy, then you should return a nil deploy and a nil error.

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) Info ¶

func (obj *GAPI) Info() *gapi.InfoResult

Info returns some data about the GAPI implementation.

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, error)

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

Source Files ¶

gapi.go puppet.go

Directories ¶