ansible-deploy-template

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 gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4

Entrypoint

Return Type

AnsibleDeployTemplate !

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \

func (m *MyModule) Example() *dagger.AnsibleDeployTemplate  {
	return dag.
			AnsibleDeployTemplate()
}

@function
def example() -> dagger.AnsibleDeployTemplate:
	return (
		dag.ansible_deploy_template()
	)

@func()
example(): AnsibleDeployTemplate {
	return dag
		.ansibleDeployTemplate()
}

Types

AnsibleDeployTemplate 🔗

build() 🔗

Build the application container (example)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			Build(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.build(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ansibleDeployTemplate()
		.build(source)
}

buildEnvWithDocker() 🔗

Install Docker (example)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build-env-with-docker --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			BuildEnvWithDocker(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.build_env_with_docker(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.buildEnvWithDocker(source)
}

buildSidecarBase() 🔗

Build a deployment environment (sidecar) base container with settings from the vscode devcontainer.json (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build-sidecar-base --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			BuildSidecarBase(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.build_sidecar_base(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ansibleDeployTemplate()
		.buildSidecarBase(source)
}

buildSidecarWithAnsible() 🔗

Build a deployment environment (sidecar) base container with ansible (pip) from the devcontainer.json (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
pipRequirementPath	String !	"/.devcontainer/requirements.txt"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build-sidecar-with-ansible --source DIR_PATH --pip-requirement-path string

func (m *MyModule) Example(source *dagger.Directory, pipRequirementPath string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			BuildSidecarWithAnsible(source, pipRequirementPath)
}

@function
def example(source: dagger.Directory, pip_requirement_path: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.build_sidecar_with_ansible(source, pip_requirement_path)
	)

@func()
example(source: Directory, pipRequirementPath: string): Container {
	return dag
		.ansibleDeployTemplate()
		.buildSidecarWithAnsible(source, pipRequirementPath)
}

buildSidecarWithAnsibleEnv() 🔗

Build a deployment environment (sidecar) base container with an ansible environment (roles and collection) from the devcontainer.json (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
collectionPath	String !	"/collections/requirements.yml"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build-sidecar-with-ansible-env --source DIR_PATH --collection-path string

func (m *MyModule) Example(source *dagger.Directory, collectionPath string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			BuildSidecarWithAnsibleEnv(source, collectionPath)
}

@function
def example(source: dagger.Directory, collection_path: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.build_sidecar_with_ansible_env(source, collection_path)
	)

@func()
example(source: Directory, collectionPath: string): Container {
	return dag
		.ansibleDeployTemplate()
		.buildSidecarWithAnsibleEnv(source, collectionPath)
}

buildSidecarWithPackages() 🔗

Build a deployment environment (sidecar) base container with the os packages from the devcontainer.json (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 build-sidecar-with-packages --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			BuildSidecarWithPackages(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.build_sidecar_with_packages(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ansibleDeployTemplate()
		.buildSidecarWithPackages(source)
}

containerEcho() 🔗

Returns a container that echoes whatever string argument is provided

Return Type

Container !

Arguments

Name	Type	Default Value	Description
message	String !	-	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 container-echo --message string

func (m *MyModule) Example(message string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			ContainerEcho(message)
}

@function
def example(message: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.container_echo(message)
	)

@func()
example(message: string): Container {
	return dag
		.ansibleDeployTemplate()
		.containerEcho(message)
}

grepDir() 🔗

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

Return Type

String !

Arguments

Name	Type	Default Value	Description
directoryArg	Directory !	-	A directory.
pattern	String !	-	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 grep-dir --directory-arg DIR_PATH --pattern string

func (m *MyModule) Example(ctx context.Context, directoryArg *dagger.Directory, pattern string) string  {
	return dag.
			AnsibleDeployTemplate().
			GrepDir(ctx, directoryArg, pattern)
}

@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.ansible_deploy_template()
		.grep_dir(directory_arg, pattern)
	)

@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.grepDir(directoryArg, pattern)
}

lintAll() 🔗

Run both YAML and JSON linting and return combined results (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 lint-all --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			LintAll(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.lint_all(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.lintAll(source)
}

lintjson() 🔗

Return the result of the task linting json files (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 lintjson --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			Lintjson(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.lintjson(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.lintjson(source)
}

lintyaml() 🔗

Return the result of the task linting yaml files (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 lintyaml --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			Lintyaml(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.lintyaml(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.lintyaml(source)
}

publish() 🔗

Publish the application container after building and testing it on-the-fly (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 publish --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			Publish(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.publish(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.publish(source)
}

pyatsTestbed() 🔗

Convert an ansible inventory into pyats testbed (example)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
assignment	String !	-	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 pyats-testbed --assignment string

func (m *MyModule) Example(assignment string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			PyatsTestbed(assignment)
}

@function
def example(assignment: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.pyats_testbed(assignment)
	)

@func()
example(assignment: string): Container {
	return dag
		.ansibleDeployTemplate()
		.pyatsTestbed(assignment)
}

run() 🔗

Execute the ansible environment with the tag deploy (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 run --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			Run(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.run(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ansibleDeployTemplate()
		.run(source)
}

sidecarAnsibleEnvExec() 🔗

Build a deployment environment (sidecar) base container with an ansible environment (roles and collection) from the devcontainer.json and execute a playbook(experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleArgs	String !	""	No description provided
ansibleInventory	String !	"/environments/local/review.yml"	No description provided
ansiblePlaybook	String !	"/playbooks/playbook.yml"	No description provided
ansibleTags	String !	"all"	No description provided
ansibleLimit	String !	"*"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 sidecar-ansible-env-exec --source DIR_PATH --ansible-args string --ansible-inventory string --ansible-playbook string --ansible-tags string --ansible-limit string

func (m *MyModule) Example(source *dagger.Directory, ansibleArgs string, ansibleInventory string, ansiblePlaybook string, ansibleTags string, ansibleLimit string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			SidecarAnsibleEnvExec(source, ansibleArgs, ansibleInventory, ansiblePlaybook, ansibleTags, ansibleLimit)
}

@function
def example(source: dagger.Directory, ansible_args: str, ansible_inventory: str, ansible_playbook: str, ansible_tags: str, ansible_limit: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.sidecar_ansible_env_exec(source, ansible_args, ansible_inventory, ansible_playbook, ansible_tags, ansible_limit)
	)

@func()
example(source: Directory, ansibleArgs: string, ansibleInventory: string, ansiblePlaybook: string, ansibleTags: string, ansibleLimit: string): Container {
	return dag
		.ansibleDeployTemplate()
		.sidecarAnsibleEnvExec(source, ansibleArgs, ansibleInventory, ansiblePlaybook, ansibleTags, ansibleLimit)
}

sidecarAnsibleEnvExecInventory() 🔗

Build a deployment environment (sidecar) base container with an ansible environment (roles and collection) from the devcontainer.json and list inventory (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansibleArgs	String !	"--list"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 sidecar-ansible-env-exec-inventory --source DIR_PATH --ansible-inventory string --ansible-args string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, ansibleInventory string, ansibleArgs string) string  {
	return dag.
			AnsibleDeployTemplate().
			SidecarAnsibleEnvExecInventory(ctx, source, ansibleInventory, ansibleArgs)
}

@function
async def example(source: dagger.Directory, ansible_inventory: str, ansible_args: str) -> str:
	return await (
		dag.ansible_deploy_template()
		.sidecar_ansible_env_exec_inventory(source, ansible_inventory, ansible_args)
	)

@func()
async example(source: Directory, ansibleInventory: string, ansibleArgs: string): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.sidecarAnsibleEnvExecInventory(source, ansibleInventory, ansibleArgs)
}

sidecarAnsibleEnvInventory() 🔗

List the ansible environment by argument –list-hosts (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/environments/local/review.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 sidecar-ansible-env-inventory --source DIR_PATH --ansible-inventory string --ansible-playbook string

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, ansibleInventory string, ansiblePlaybook string) string  {
	return dag.
			AnsibleDeployTemplate().
			SidecarAnsibleEnvInventory(ctx, source, ansibleInventory, ansiblePlaybook)
}

@function
async def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str) -> str:
	return await (
		dag.ansible_deploy_template()
		.sidecar_ansible_env_inventory(source, ansible_inventory, ansible_playbook)
	)

@func()
async example(source: Directory, ansibleInventory: string, ansiblePlaybook: string): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.sidecarAnsibleEnvInventory(source, ansibleInventory, ansiblePlaybook)
}

sidecarAnsibleEnvSyntaxcheck() 🔗

Verify the ansible environment by syntax check (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/environments/local/review.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 sidecar-ansible-env-syntaxcheck --source DIR_PATH --ansible-inventory string --ansible-playbook string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			SidecarAnsibleEnvSyntaxcheck(source, ansibleInventory, ansiblePlaybook)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.sidecar_ansible_env_syntaxcheck(source, ansible_inventory, ansible_playbook)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string): Container {
	return dag
		.ansibleDeployTemplate()
		.sidecarAnsibleEnvSyntaxcheck(source, ansibleInventory, ansiblePlaybook)
}

sidecarVerify() 🔗

Verify the ansible environment (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/environments/local/review.yml"	No description provided
ansiblePlaybook	String !	"/playbooks/playbook.yml"	No description provided
ansibleTags	String !	"all"	No description provided
ansibleLimit	String !	"*"	No description provided
ansibleArgs	String !	"local"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 sidecar-verify --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-tags string --ansible-limit string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleTags string, ansibleLimit string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			SidecarVerify(source, ansibleInventory, ansiblePlaybook, ansibleTags, ansibleLimit, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_tags: str, ansible_limit: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.sidecar_verify(source, ansible_inventory, ansible_playbook, ansible_tags, ansible_limit, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleTags: string, ansibleLimit: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.sidecarVerify(source, ansibleInventory, ansiblePlaybook, ansibleTags, ansibleLimit, ansibleArgs)
}

stageBuild() 🔗

Execute the ansible environment with the tag build (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	"-c local"	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-build --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageBuild(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_build(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageBuild(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stageDeploy() 🔗

Execute the ansible environment with the tag deploy (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-deploy --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageDeploy(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_deploy(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageDeploy(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stageDocument() 🔗

Execute the ansible environment with the tag deploy (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-document --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageDocument(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_document(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageDocument(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stagePrepare() 🔗

Execute the ansible environment with the tag prepare (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-prepare --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StagePrepare(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_prepare(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stagePrepare(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stageRelease() 🔗

Execute the ansible environment with the tag package,release (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-release --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageRelease(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_release(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageRelease(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stageSast() 🔗

Execute the ansible environment with the tag static_tests (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-sast --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageSast(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_sast(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageSast(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

stageValidate() 🔗

Verify the ansible environment by syntax check (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-validate --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageValidate(source)
}

@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_validate(source)
	)

@func()
example(source: Directory): Container {
	return dag
		.ansibleDeployTemplate()
		.stageValidate(source)
}

stageVerify() 🔗

Execute the ansible environment with the tag deploy (experimental)

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.
ansibleInventory	String !	"/inventory/all.yml"	No description provided
ansiblePlaybook	String !	"/all-services.yml"	No description provided
ansibleArgs	String !	""	No description provided

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 stage-verify --source DIR_PATH --ansible-inventory string --ansible-playbook string --ansible-args string

func (m *MyModule) Example(source *dagger.Directory, ansibleInventory string, ansiblePlaybook string, ansibleArgs string) *dagger.Container  {
	return dag.
			AnsibleDeployTemplate().
			StageVerify(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

@function
def example(source: dagger.Directory, ansible_inventory: str, ansible_playbook: str, ansible_args: str) -> dagger.Container:
	return (
		dag.ansible_deploy_template()
		.stage_verify(source, ansible_inventory, ansible_playbook, ansible_args)
	)

@func()
example(source: Directory, ansibleInventory: string, ansiblePlaybook: string, ansibleArgs: string): Container {
	return dag
		.ansibleDeployTemplate()
		.stageVerify(source, ansibleInventory, ansiblePlaybook, ansibleArgs)
}

test() 🔗

Return the result of running unit tests (example)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 test --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			Test(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.test(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.test(source)
}

yamllintExtern() 🔗

Run both YAML and JSON linting and return combined results (experimental)

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	A directory.

Example

dagger -m gitlab.com/rstumpner/ansible-deploy-template@a05a7e4ef4478dea326146adf06de3b1176cede4 call \
 yamllint-extern --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			AnsibleDeployTemplate().
			YamllintExtern(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.ansible_deploy_template()
		.yamllint_extern(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.ansibleDeployTemplate()
		.yamllintExtern(source)
}