puppet

Documentation

Overview

Package puppet provides the integration entrypoint for the puppet language.

Index

• Constants
• func ParseConfigFromPuppet(puppetParam, puppetConf string) *yamlgraph.GraphConfig
• func RefreshInterval(puppetConf string) int
• type GAPI
  • func NewGAPI(data gapi.Data, puppetParam *string, puppetConf string) (*GAPI, error)
  • 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

Constants

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
)

Functions

func ParseConfigFromPuppet

func ParseConfigFromPuppet(puppetParam, puppetConf string) *yamlgraph.GraphConfig

ParseConfigFromPuppet takes a special puppet param string and config and returns the graph configuration structure.

func RefreshInterval

func RefreshInterval(puppetConf string) int

RefreshInterval returns the graph refresh interval from the puppet configuration.

Types

type GAPI

type GAPI struct {
	PuppetParam *string // puppet mode to run; nil if undefined
	PuppetConf  string  // the path to an alternate puppet.conf file
	// contains filtered or unexported fields
}

GAPI implements the main puppet GAPI interface.

func NewGAPI

func NewGAPI(data gapi.Data, puppetParam *string, puppetConf string) (*GAPI, error)

NewGAPI creates a new puppet GAPI struct and calls Init().

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.