data-tool
Installation
Entrypoint
Types
DataTool

data-tool

Module for interacting with ASCE Data Tool (a.k.a., ace-dt)

Installation

dagger install github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc

Entrypoint

Return Type

DataTool !

Arguments

Name	Type	Default Value	Description
base	Container	-	No description provided

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \

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

@function
def example() -> dagger.DataTool:
	return (
		dag.data_tool()
	)

@func()
example(): DataTool {
	return dag
		.dataTool()
}

Types

DataTool 🔗

ASCE Data Tool Module

container() 🔗

Return Type

Container !

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 container

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

@function
def example() -> dagger.Container:
	return (
		dag.data_tool()
		.container()
	)

@func()
example(): Container {
	return dag
		.dataTool()
		.container()
}

withRegistryAuth() 🔗

Add credentials for a registry

Return Type

DataTool !

Arguments

Name	Type	Default Value	Description
address	String !	-	registry's hostname
username	String !	-	username in registry
secret	Secret !	-	password or token for registry

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 with-registry-auth --address string --username string --secret env:MYSECRET

func (m *MyModule) Example(address string, username string, secret *dagger.Secret) *dagger.DataTool  {
	return dag.
			DataTool().
			WithRegistryAuth(address, username, secret)
}

@function
def example(address: str, username: str, secret: dagger.Secret) -> dagger.DataTool:
	return (
		dag.data_tool()
		.with_registry_auth(address, username, secret)
	)

@func()
example(address: string, username: string, secret: Secret): DataTool {
	return dag
		.dataTool()
		.withRegistryAuth(address, username, secret)
}

withGitAuth() 🔗

Add credentials for use with Git via “ace-dt git”

Return Type

DataTool !

Arguments

Name	Type	Default Value	Description
address	String !	-	registry's hostname
username	String !	-	username in registry
secret	Secret !	-	password or token for registry

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 with-git-auth --address string --username string --secret env:MYSECRET

func (m *MyModule) Example(address string, username string, secret *dagger.Secret) *dagger.DataTool  {
	return dag.
			DataTool().
			WithGitAuth(address, username, secret)
}

@function
def example(address: str, username: str, secret: dagger.Secret) -> dagger.DataTool:
	return (
		dag.data_tool()
		.with_git_auth(address, username, secret)
	)

@func()
example(address: string, username: string, secret: Secret): DataTool {
	return dag
		.dataTool()
		.withGitAuth(address, username, secret)
}

gather() 🔗

Gathers the images and returns the full image reference with digest

Return Type

String !

Arguments

Name	Type	Default Value	Description
artifacts	File !	-	artifact CSV file
dest	String !	-	Destination for the gathered image as a OCI image reference
platforms	[Scalar ! ]	-	platforms

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 gather --artifacts file:path --dest string

func (m *MyModule) Example(ctx context.Context, artifacts *dagger.File, dest string) string  {
	return dag.
			DataTool().
			Gather(ctx, artifacts, dest)
}

@function
async def example(artifacts: dagger.File, dest: str) -> str:
	return await (
		dag.data_tool()
		.gather(artifacts, dest)
	)

@func()
async example(artifacts: File, dest: string): Promise<string> {
	return dag
		.dataTool()
		.gather(artifacts, dest)
}

scatter() 🔗

Scatter images to their proper locations from a gathered image

Return Type

Void !

Arguments

Name	Type	Default Value	Description
ref	String !	-	Gathered image reference to use as the source
mapping	File !	-	artifact CSV file

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 scatter --ref string --mapping file:path

func (m *MyModule) Example(ctx context.Context, ref string, mapping *dagger.File)   {
	return dag.
			DataTool().
			Scatter(ctx, ref, mapping)
}

@function
async def example(ref: str, mapping: dagger.File) -> None:
	return await (
		dag.data_tool()
		.scatter(ref, mapping)
	)

@func()
async example(ref: string, mapping: File): Promise<void> {
	return dag
		.dataTool()
		.scatter(ref, mapping)
}

grypeDb() 🔗

Download the Grype vulnerability database

Return Type

Directory !

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 grype-db

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			DataTool().
			GrypeDb()
}

@function
def example() -> dagger.Directory:
	return (
		dag.data_tool()
		.grype_db()
	)

@func()
example(): Directory {
	return dag
		.dataTool()
		.grypeDb()
}

serialize() 🔗

Serialize a gathered OCI image into a TAR archive file

Return Type

File !

Arguments

Name	Type	Default Value	Description
ref	String !	-	OCI reference to the gathered image artifact
manifestJson	Boolean	-	Include the manifest.json file (docker compatible)

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 serialize --ref string

func (m *MyModule) Example(ref string) *dagger.File  {
	return dag.
			DataTool().
			Serialize(ref)
}

@function
def example(ref: str) -> dagger.File:
	return (
		dag.data_tool()
		.serialize(ref)
	)

@func()
example(ref: string): File {
	return dag
		.dataTool()
		.serialize(ref)
}

archive() 🔗

Archive the provided OPCI artifacts in an archive

Return Type

File !

Arguments

Name	Type	Default Value	Description
artifacts	File !	-	artifact CSV file
platforms	[Scalar ! ]	-	filter by platforms
manifestJson	Boolean	-	Include the manifest.json file (docker compatible)

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 archive --artifacts file:path

func (m *MyModule) Example(artifacts *dagger.File) *dagger.File  {
	return dag.
			DataTool().
			Archive(artifacts)
}

@function
def example(artifacts: dagger.File) -> dagger.File:
	return (
		dag.data_tool()
		.archive(artifacts)
	)

@func()
example(artifacts: File): File {
	return dag
		.dataTool()
		.archive(artifacts)
}

scan() 🔗

Scan the images for vulnerabilities

Return Type

String !

Arguments

Name	Type	Default Value	Description
image	String !	-	Gathered image reference

Example

dagger -m github.com/act3-ai/dagger/data-tool@6b12125b00add75f119a2b6cba28a2ceef2f46cc call \
 scan --image string

func (m *MyModule) Example(ctx context.Context, image string) string  {
	return dag.
			DataTool().
			Scan(ctx, image)
}

@function
async def example(image: str) -> str:
	return await (
		dag.data_tool()
		.scan(image)
	)

@func()
async example(image: string): Promise<string> {
	return dag
		.dataTool()
		.scan(image)
}