ansible

package

v0.7.0 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/marshallford/terraform-provider-ansible

Links

Open Source Insights

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 ¶

View Source

const NavigatorProgram = "ansible-navigator"

Variables ¶

View Source

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 ¶ added in v0.7.0

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

func CreateRunDir ¶ added in v0.2.0

func CreateRunDir(dir string) error

func CreateRunPrivateKeysDir ¶ added in v0.7.0

func CreateRunPrivateKeysDir(dir string) error

func DirectoryPreflight ¶ added in v0.1.1

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 ¶ added in v0.5.0

func GetStatusFromPlaybookArtifact(dir string) (string, error)

func GetStdoutFromPlaybookArtifact ¶ added in v0.5.0

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 ¶ added in v0.2.0

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
}

type PlaybookArtifact ¶ added in v0.5.0

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

type PrivateKey ¶ added in v0.7.0

type PrivateKey struct {
	Name string
	Data string
}

type RunOptions ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL