Dagger
Search

ansible

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/bradfordwagner/dagger-modules/ansible@b16ea13928ca7fe1c1a6b9ed2932d92e0bf33c34

Entrypoint

Return Type
Ansible
Example
func (m *myModule) example() *Ansible  {
	return dag.
			Ansible()
}
@function
def example() -> dag.Ansible:
	return (
		dag.ansible()
	)
@func()
example(): Ansible {
	return dag
		.ansible()
}

Types

Ansible 🔗

build() 🔗

Build - builds the container image

Return Type
String !
Arguments
NameTypeDefault ValueDescription
indexInteger !0No description provided
srcDirectory !-No description provided
versionString !"latest"No description provided
invalidateCacheBoolean !falseNo description provided
isDevBoolean !trueNo description provided
flavorString !"playbook"No description provided
Example
func (m *myModule) example(ctx context.Context, index int, src *Directory, version string, invalidateCache bool, isDev bool, flavor string) string  {
	return dag.
			Ansible().
			Build(ctx, index, src, version, invalidateCache, isDev, flavor)
}
@function
async def example(index: int, src: dagger.Directory, version: str, invalidate_cache: bool, is_dev: bool, flavor: str) -> str:
	return await (
		dag.ansible()
		.build(index, src, version, invalidate_cache, is_dev, flavor)
	)
@func()
async example(index: number, src: Directory, version: string, invalidateCache: boolean, isDev: boolean, flavor: string): Promise<string> {
	return dag
		.ansible()
		.build(index, src, version, invalidateCache, isDev, flavor)
}

containerEcho() 🔗

Returns a container that echoes whatever string argument is provided

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
stringArgString !-No description provided
Example
func (m *myModule) example(stringArg string) *Container  {
	return dag.
			Ansible().
			ContainerEcho(stringArg)
}
@function
def example(string_arg: str) -> dagger.Container:
	return (
		dag.ansible()
		.container_echo(string_arg)
	)
@func()
example(stringArg: string): Container {
	return dag
		.ansible()
		.containerEcho(stringArg)
}

grepDir() 🔗

Returns lines that match a pattern in the files of the provided Directory

Return Type
String !
Arguments
NameTypeDefault ValueDescription
directoryArgDirectory !-No description provided
patternString !-No description provided
Example
func (m *myModule) example(ctx context.Context, directoryArg *Directory, pattern string) string  {
	return dag.
			Ansible().
			GrepDir(ctx, directoryArg, pattern)
}
@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.ansible()
		.grep_dir(directory_arg, pattern)
	)
@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.ansible()
		.grepDir(directoryArg, pattern)
}

init() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
Example
func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Ansible().
			Init(ctx, src)
}
@function
async def example(src: dagger.Directory) -> str:
	return await (
		dag.ansible()
		.init(src)
	)
@func()
async example(src: Directory): Promise<string> {
	return dag
		.ansible()
		.init(src)
}

manifest() 🔗

Manifest - configures manifest in registry. not meant to be run locally

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
versionString !"latest"No description provided
actorSecret !-GitHub actor, --token=env:GITHUB_API_TOKEN,--token=cmd:"gh auth token"
tokenSecret !-GitHub API token, --token=env:GITHUB_API_TOKEN,--token=cmd:"gh auth token"
Example
func (m *myModule) example(ctx context.Context, src *Directory, version string, actor *Secret, token *Secret) string  {
	return dag.
			Ansible().
			Manifest(ctx, src, version, actor, token)
}
@function
async def example(src: dagger.Directory, version: str, actor: dagger.Secret, token: dagger.Secret) -> str:
	return await (
		dag.ansible()
		.manifest(src, version, actor, token)
	)
@func()
async example(src: Directory, version: string, actor: Secret, token: Secret): Promise<string> {
	return dag
		.ansible()
		.manifest(src, version, actor, token)
}

product() 🔗

Product returns the cartesian product of all builds this is used to explode the builds

Return Type
[ProductFormat ! ] !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
versionString !"latest"No description provided
Example
func (m *myModule) example(src *Directory, version string) []*AnsibleProductFormat  {
	return dag.
			Ansible().
			Product(src, version)
}
@function
def example(src: dagger.Directory, version: str) -> List[dag.AnsibleProductFormat]:
	return (
		dag.ansible()
		.product(src, version)
	)
@func()
example(src: Directory, version: string): AnsibleProductFormat[] {
	return dag
		.ansible()
		.product(src, version)
}

productJson() 🔗

ProductJson returns the cartesian product of all builds as a json string, used for github actions matrix

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
versionString !"latest"No description provided
Example
func (m *myModule) example(ctx context.Context, src *Directory, version string) string  {
	return dag.
			Ansible().
			ProductJson(ctx, src, version)
}
@function
async def example(src: dagger.Directory, version: str) -> str:
	return await (
		dag.ansible()
		.product_json(src, version)
	)
@func()
async example(src: Directory, version: string): Promise<string> {
	return dag
		.ansible()
		.productJson(src, version)
}

ProductFormat 🔗

arch() 🔗

Return Type
String !
Example
Function AnsibleProductFormat.arch is not accessible from the ansible module
Function AnsibleProductFormat.arch is not accessible from the ansible module
Function AnsibleProductFormat.arch is not accessible from the ansible module

index() 🔗

Return Type
Integer !
Example
Function AnsibleProductFormat.index is not accessible from the ansible module
Function AnsibleProductFormat.index is not accessible from the ansible module
Function AnsibleProductFormat.index is not accessible from the ansible module

os() 🔗

Return Type
String !
Example
Function AnsibleProductFormat.os is not accessible from the ansible module
Function AnsibleProductFormat.os is not accessible from the ansible module
Function AnsibleProductFormat.os is not accessible from the ansible module

runner() 🔗

Return Type
String !
Example
Function AnsibleProductFormat.runner is not accessible from the ansible module
Function AnsibleProductFormat.runner is not accessible from the ansible module
Function AnsibleProductFormat.runner is not accessible from the ansible module

targetImage() 🔗

without architecture suffix

Return Type
String !
Example
Function AnsibleProductFormat.targetImage is not accessible from the ansible module
Function AnsibleProductFormat.targetImage is not accessible from the ansible module
Function AnsibleProductFormat.targetImage is not accessible from the ansible module

upstreamImage() 🔗

Return Type
String !
Example
Function AnsibleProductFormat.upstreamImage is not accessible from the ansible module
Function AnsibleProductFormat.upstreamImage is not accessible from the ansible module
Function AnsibleProductFormat.upstreamImage is not accessible from the ansible module