ansible
Copyright © 2024 Patrick Hermann patrick.hermann@sva.de
Installation
dagger install github.com/stuttgart-things/dagger/ansible@v0.2.1
Entrypoint
Return Type
Ansible !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
ansibleContainer | Container | - | ansible container It need contain ansible |
githubContainer | Container | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
func (m *myModule) example() *Ansible {
return dag.
Ansible()
}
@function
def example() -> dag.Ansible:
return (
dag.ansible()
)
@func()
example(): Ansible {
return dag
.ansible()
}
Types
Ansible 🔗
ansibleContainer() 🔗
Return Type
Container !
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
ansible-container
func (m *myModule) example() *Container {
return dag.
Ansible().
AnsibleContainer()
}
@function
def example() -> dagger.Container:
return (
dag.ansible()
.ansible_container()
)
@func()
example(): Container {
return dag
.ansible()
.ansibleContainer()
}
runCollectionBuildPipeline() 🔗
RunCollectionBuildPipeline orchestrates init, modify and build of an ansible collection
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
run-collection-build-pipeline --src DIR_PATH
func (m *myModule) example(src *Directory) *Directory {
return dag.
Ansible().
RunCollectionBuildPipeline(src)
}
@function
def example(src: dagger.Directory) -> dagger.Directory:
return (
dag.ansible()
.run_collection_build_pipeline(src)
)
@func()
example(src: Directory): Directory {
return dag
.ansible()
.runCollectionBuildPipeline(src)
}
githubRelease() 🔗
BUILDS A GIVEN COLLECTION DIR TO A ARCHIVE FILE (.TGZ)
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
tag | String ! | - | No description provided |
title | String ! | - | No description provided |
group | String ! | - | No description provided |
repo | String ! | - | No description provided |
files | [File ! ] ! | - | No description provided |
notes | String ! | - | No description provided |
token | Secret ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
github-release --tag string --title string --group string --repo string --notes string --token env:MYSECRET
func (m *myModule) example(ctx context.Context, tag string, title string, group string, repo string, files []*File, notes string, token *Secret) {
return dag.
Ansible().
GithubRelease(ctx, tag, title, group, repo, files, notes, token)
}
@function
async def example(tag: str, title: str, group: str, repo: str, files: List[dagger.File], notes: str, token: dagger.Secret) -> None:
return await (
dag.ansible()
.github_release(tag, title, group, repo, files, notes, token)
)
@func()
async example(tag: string, title: string, group: string, repo: string, files: File[], notes: string, token: Secret): Promise<void> {
return dag
.ansible()
.githubRelease(tag, title, group, repo, files, notes, token)
}
build() 🔗
BUILDS A GIVEN COLLECTION DIR TO A ARCHIVE FILE (.TGZ)
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
build --src DIR_PATH
func (m *myModule) example(src *Directory) *Directory {
return dag.
Ansible().
Build(src)
}
@function
def example(src: dagger.Directory) -> dagger.Directory:
return (
dag.ansible()
.build(src)
)
@func()
example(src: Directory): Directory {
return dag
.ansible()
.build(src)
}
modifyRoleIncludes() 🔗
BUILDS A GIVEN COLLECTION DIR TO A ARCHIVE FILE (.TGZ)
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
modify-role-includes --src DIR_PATH
func (m *myModule) example(src *Directory) *Directory {
return dag.
Ansible().
ModifyRoleIncludes(src)
}
@function
def example(src: dagger.Directory) -> dagger.Directory:
return (
dag.ansible()
.modify_role_includes(src)
)
@func()
example(src: Directory): Directory {
return dag
.ansible()
.modifyRoleIncludes(src)
}
initCollection() 🔗
INIT ANSIBLE COLLECTION STRUCTURE
Return Type
CollectionResult !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | No description provided |
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
init-collection --src DIR_PATH
func (m *myModule) example(src *Directory) *AnsibleCollectionResult {
return dag.
Ansible().
InitCollection(src)
}
@function
def example(src: dagger.Directory) -> dag.AnsibleCollectionResult:
return (
dag.ansible()
.init_collection(src)
)
@func()
example(src: Directory): AnsibleCollectionResult {
return dag
.ansible()
.initCollection(src)
}
getAnsibleContainer() 🔗
GetAnsibleContainer return the default image for helm
Return Type
Container !
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
get-ansible-container
func (m *myModule) example() *Container {
return dag.
Ansible().
GetAnsibleContainer()
}
@function
def example() -> dagger.Container:
return (
dag.ansible()
.get_ansible_container()
)
@func()
example(): Container {
return dag
.ansible()
.getAnsibleContainer()
}
CollectionResult 🔗
directory() 🔗
Return Type
Directory !
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
init-collection --src DIR_PATH \
directory
func (m *myModule) example(src *Directory) *Directory {
return dag.
Ansible().
InitCollection(src).
Directory()
}
@function
def example(src: dagger.Directory) -> dagger.Directory:
return (
dag.ansible()
.init_collection(src)
.directory()
)
@func()
example(src: Directory): Directory {
return dag
.ansible()
.initCollection(src)
.directory()
}
namespace() 🔗
Return Type
String !
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
init-collection --src DIR_PATH \
namespace
func (m *myModule) example(ctx context.Context, src *Directory) string {
return dag.
Ansible().
InitCollection(src).
Namespace(ctx)
}
@function
async def example(src: dagger.Directory) -> str:
return await (
dag.ansible()
.init_collection(src)
.namespace()
)
@func()
async example(src: Directory): Promise<string> {
return dag
.ansible()
.initCollection(src)
.namespace()
}
name() 🔗
Return Type
String !
Example
dagger -m github.com/stuttgart-things/dagger/ansible@1db2eb2185d0c9ce050b1345e56c82cc16aca7c9 call \
init-collection --src DIR_PATH \
name
func (m *myModule) example(ctx context.Context, src *Directory) string {
return dag.
Ansible().
InitCollection(src).
Name(ctx)
}
@function
async def example(src: dagger.Directory) -> str:
return await (
dag.ansible()
.init_collection(src)
.name()
)
@func()
async example(src: Directory): Promise<string> {
return dag
.ansible()
.initCollection(src)
.name()
}