plugin

Documentation

Index

• Constants
• Variables
• type Plugin
  • func New(settings Settings, pipeline drone.Pipeline, network drone.Network) *Plugin
  • func (p *Plugin) Execute() error
  • func (p *Plugin) Validate() error
• type Settings

Constants

const (
	AnsibleForksDefault = 5
)

Variables

var (
	ErrPluginPlaybookNotSet  = errors.New("playbook is required")
	ErrPluginInventoryNotSet = errors.New("inventory is required")
)

var ErrAnsiblePlaybookNotFound = errors.New("playbook not found")

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin implements drone.Plugin to provide the plugin implementation.

func New

func New(settings Settings, pipeline drone.Pipeline, network drone.Network) *Plugin

New initializes a plugin from the given Settings, Pipeline, and Network.

func (*Plugin) Execute

func (p *Plugin) Execute() error

Execute provides the implementation of the plugin.

func (*Plugin) Validate

func (p *Plugin) Validate() error

Validate handles the settings validation of the plugin.

type Settings

type Settings struct {
	Requirements      string
	Galaxy            string
	Inventories       cli.StringSlice
	Playbooks         cli.StringSlice
	Limit             string
	SkipTags          string
	StartAtTask       string
	Tags              string
	ExtraVars         cli.StringSlice
	ModulePath        cli.StringSlice
	Check             bool
	Diff              bool
	FlushCache        bool
	ForceHandlers     bool
	ListHosts         bool
	ListTags          bool
	ListTasks         bool
	SyntaxCheck       bool
	Forks             int
	VaultID           string
	VaultPassword     string
	VaultPasswordFile string
	Verbose           int
	PrivateKey        string
	PrivateKeyFile    string
	User              string
	Connection        string
	Timeout           int
	SSHCommonArgs     string
	SFTPExtraArgs     string
	SCPExtraArgs      string
	SSHExtraArgs      string
	Become            bool
	BecomeMethod      string
	BecomeUser        string
}

Settings for the Plugin.