ansible

Documentation

Index

• Constants
• Variables
• func ContainerEngineOptions() []string
• func ContainerEnginePreflight(containerEngine string) error
• func CreateInventoryFile(dir string, inventoryContents string) 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 CreateRunPrivateKeysDir(dir string) error
• func DirectoryPreflight(dir string) error
• func ExecNavigatorRunCommand(command *exec.Cmd) (string, error)
• func GenerateNavigatorRunCommand(workingDirectory string, ansibleNavigatorBinary string, runDir string, ...) *exec.Cmd
• func GenerateNavigatorSettings(settings *NavigatorSettings) (string, error)
• func GetStatusFromPlaybookArtifact(dir string) (string, error)
• func GetStdoutFromPlaybookArtifact(dir string) (string, error)
• func NavigatorPath() (string, error)
• func NavigatorPreflight(binary string) error
• func PullPolicyOptions() []string
• func QueryPlaybookArtifact(dir string, queries map[string]ArtifactQuery) error
• func RemoveRunDir(dir string) error
• type ArtifactQuery
• type NavigatorSettings
• type PlaybookArtifact
• type PrivateKey
• type RunOptions

Constants

const NavigatorProgram = "ansible-navigator"

Variables

var (
	ErrDirectory           = errors.New("directory is not valid")
	ErrContainerEnginePath = errors.New("container engine (podman or docker) must exist in PATH")
	ErrContainerEngine     = errors.New("container engine is not running or usable")
	ErrNavigatorPath       = fmt.Errorf("%s does not exist in PATH", NavigatorProgram)
	ErrNavigator           = fmt.Errorf("%s is not functional", NavigatorProgram)
)

Functions

func ContainerEngineOptions

func ContainerEngineOptions() []string

func ContainerEnginePreflight

func ContainerEnginePreflight(containerEngine string) error

func CreateInventoryFile

func CreateInventoryFile(dir string, inventoryContents string) 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 CreateRunPrivateKeysDir

func CreateRunPrivateKeysDir(dir string) error

func DirectoryPreflight

func DirectoryPreflight(dir string) error

func ExecNavigatorRunCommand

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

func GenerateNavigatorRunCommand

func GenerateNavigatorRunCommand(workingDirectory string, ansibleNavigatorBinary string, runDir string, opts *RunOptions) *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 NavigatorPath

func NavigatorPath() (string, error)

func NavigatorPreflight

func NavigatorPreflight(binary string) 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

Types

type ArtifactQuery

type ArtifactQuery struct {
	JSONPath string
	Result   string
}

type NavigatorSettings

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

type PlaybookArtifact

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

type PrivateKey

type PrivateKey struct {
	Name string
	Data string
}

type RunOptions

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