ansible

Documentation

Index

• Constants
• Variables
• func ContainerEngineOptions(auto bool) []string
• func ContainerEnginePreflight(containerEngine string) error
• func CreateInventoryFile(dir string, inventoryContents string) error
• func CreateKnownHosts(dir string, knownHosts []KnownHost, settings *NavigatorSettings) error
• func CreateNavigatorSettingsFile(dir string, settingsContents string) error
• func CreatePlaybookFile(dir string, playbookContents string) error
• func CreatePrivateKeys(dir string, keys []PrivateKey, settings *NavigatorSettings) error
• func CreateRunDir(dir string) error
• func DirectoryPreflight(dir string) error
• func ExecNavigatorRunCommand(command *exec.Cmd) (string, error)
• func GenerateNavigatorRunCommand(runDir string, workingDir string, ansibleNavigatorBinary string, ...) *exec.Cmd
• func GenerateNavigatorSettings(settings *NavigatorSettings) (string, error)
• func GetStatusFromPlaybookArtifact(dir string) (string, error)
• func GetStdoutFromPlaybookArtifact(dir string) (string, error)
• func NavigatorPathPreflight(path string) (string, error)
• func NavigatorPreflight(binary string) error
• func PlaybookPreflight() error
• func PullPolicyOptions() []string
• func QueryPlaybookArtifact(dir string, queries map[string]ArtifactQuery) error
• func RemoveRunDir(dir string) error
• func ValidateJQFilter(filter string) error
• type ArtifactQuery
• type KnownHost
  • func GetKnownHosts(dir string) ([]KnownHost, error)
• type NavigatorSettings
• type Options
• type PlaybookArtifact
• type PrivateKey

Constants

const (
	NavigatorProgram    = "ansible-navigator"
	PlaybookProgram     = "ansible-playbook"
	ContainerEngineAuto = "auto"
)

const (
	SSHKnownHostsFileVar = "ansible_ssh_known_hosts_file"
)

Variables

var (
	ErrDirectory               = errors.New("directory is not valid")
	ErrContainerEngineValidate = errors.New("container engine is not valid")
	ErrContainerEnginePath     = errors.New("container engine must exist in PATH")
	ErrContainerEngineRunning  = errors.New("container engine is not running or usable")
	ErrNavigatorAbsPath        = fmt.Errorf("absolute path of %s cannot be represented", NavigatorProgram)
	ErrNavigatorPath           = fmt.Errorf("%s does not exist in PATH", NavigatorProgram)
	ErrNavigator               = fmt.Errorf("%s is not functional", NavigatorProgram)
	ErrPlaybookPath            = fmt.Errorf("%s does not exist in PATH", PlaybookProgram)
	ErrPlaybook                = fmt.Errorf("%s is not functional", PlaybookProgram)
)

Functions

func ContainerEngineOptions

func ContainerEngineOptions(auto bool) []string

func ContainerEnginePreflight

func ContainerEnginePreflight(containerEngine string) error

func CreateInventoryFile

func CreateInventoryFile(dir string, inventoryContents string) error

func CreateKnownHosts

func CreateKnownHosts(dir string, knownHosts []KnownHost, settings *NavigatorSettings) error

func CreateNavigatorSettingsFile

func CreateNavigatorSettingsFile(dir string, settingsContents string) error

func CreatePlaybookFile

func CreatePlaybookFile(dir string, playbookContents string) error

func CreatePrivateKeys

func CreatePrivateKeys(dir string, keys []PrivateKey, settings *NavigatorSettings) error

func CreateRunDir

func CreateRunDir(dir string) error

func DirectoryPreflight

func DirectoryPreflight(dir string) error

func ExecNavigatorRunCommand

func ExecNavigatorRunCommand(command *exec.Cmd) (string, error)

func GenerateNavigatorRunCommand

func GenerateNavigatorRunCommand(runDir string, workingDir string, ansibleNavigatorBinary string, eeEnabled bool, options *Options) *exec.Cmd

func GenerateNavigatorSettings

func GenerateNavigatorSettings(settings *NavigatorSettings) (string, error)

func GetStatusFromPlaybookArtifact

func GetStatusFromPlaybookArtifact(dir string) (string, error)

func GetStdoutFromPlaybookArtifact

func GetStdoutFromPlaybookArtifact(dir string) (string, error)

func NavigatorPathPreflight

func NavigatorPathPreflight(path string) (string, error)

func NavigatorPreflight

func NavigatorPreflight(binary string) error

TODO include output in error TODO require a min version

func PlaybookPreflight

func PlaybookPreflight() error

TODO include output in error TODO require a min version

func PullPolicyOptions

func PullPolicyOptions() []string

func QueryPlaybookArtifact

func QueryPlaybookArtifact(dir string, queries map[string]ArtifactQuery) error

func RemoveRunDir

func RemoveRunDir(dir string) error

func ValidateJQFilter

func ValidateJQFilter(filter string) error

Types

type ArtifactQuery

type ArtifactQuery struct {
	JQFilter string
	Results  []string
}

type KnownHost

type KnownHost = string

func GetKnownHosts

func GetKnownHosts(dir string) ([]KnownHost, error)

type NavigatorSettings

type NavigatorSettings struct {
	Timeout                  time.Duration
	EEEnabled                bool
	ContainerEngine          string
	EnvironmentVariablesPass []string
	EnvironmentVariablesSet  map[string]string
	Image                    string
	PullArguments            []string
	PullPolicy               string
	VolumeMounts             map[string]string
	ContainerOptions         []string
	Timezone                 string
}

type Options

type Options struct {
	ForceHandlers bool
	SkipTags      []string
	StartAtTask   string
	Limit         []string
	Tags          []string
	PrivateKeys   []string
	KnownHosts    bool
}

type PlaybookArtifact

type PlaybookArtifact struct {
	Status string   `json:"status"`
	Stdout []string `json:"stdout"`
}

type PrivateKey

type PrivateKey struct {
	Name string
	Data string
}