Dagger
Search

jumppad

No long description provided.

Installation

dagger install github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f

Entrypoint

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

Types

Jumppad

binary()

Return Type
File !
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 binary
func (m *myModule) example() *File  {
	return dag.
			Jumppad().
			Binary()
}
@function
def example() -> dagger.File:
	return (
		dag.jumppad()
		.binary()
	)
@func()
example(): File {
	return dag
		.jumppad()
		.binary()
}

cache()

Return Type
CacheVolume !
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 cache
func (m *myModule) example() *CacheVolume  {
	return dag.
			Jumppad().
			Cache()
}
@function
def example() -> dagger.CacheVolume:
	return (
		dag.jumppad()
		.cache()
	)
@func()
example(): CacheVolume {
	return dag
		.jumppad()
		.cache()
}

withVersion()

WithVersion installs a specific version of jumppad from GitHub releases

Return Type
Jumppad !
Arguments
NameTypeDefault ValueDescription
versionString !-the version of jumppad to install
architectureString !-the architecture to install jumppad for, i.e. amd64, arm64.
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 with-version --version string --architecture string \
 test-blueprint --src DIR_PATH
func (m *myModule) example(version string, architecture string) *Jumppad  {
	return dag.
			Jumppad().
			WithVersion(version, architecture)
}
@function
def example(version: str, architecture: str) -> dag.Jumppad:
	return (
		dag.jumppad()
		.with_version(version, architecture)
	)
@func()
example(version: string, architecture: string): Jumppad {
	return dag
		.jumppad()
		.withVersion(version, architecture)
}

withFile()

WithFile installs a specific version of jumppad from the provided file

Return Type
Jumppad !
Arguments
NameTypeDefault ValueDescription
fileFile !-the file to use as the jumppad binary
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 with-file --file file:path \
 test-blueprint --src DIR_PATH
func (m *myModule) example(file *File) *Jumppad  {
	return dag.
			Jumppad().
			WithFile(file)
}
@function
def example(file: dagger.File) -> dag.Jumppad:
	return (
		dag.jumppad()
		.with_file(file)
	)
@func()
example(file: File): Jumppad {
	return dag
		.jumppad()
		.withFile(file)
}

withCache()

WithCache uses a specifies cache volume for docker or podman server

Return Type
Jumppad !
Arguments
NameTypeDefault ValueDescription
cacheCacheVolume !-the cache volume to use
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 with-cache --cache VOLUME_NAME \
 test-blueprint --src DIR_PATH
func (m *myModule) example(cache *CacheVolume) *Jumppad  {
	return dag.
			Jumppad().
			WithCache(cache)
}
@function
def example(cache: dagger.CacheVolume) -> dag.Jumppad:
	return (
		dag.jumppad()
		.with_cache(cache)
	)
@func()
example(cache: CacheVolume): Jumppad {
	return dag
		.jumppad()
		.withCache(cache)
}

testBlueprint()

TestBlueprint tests a blueprint using either docker or podman, this method is designed to be used with the Dagger API not the CLI

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-the directory containing the blueprint to test
workingDirectoryString -the working directory to run the test in, this is relative to the src directory
architectureString "amd64"the architecture to test the blueprint on, i.e. amd64, arm64.
runtimeString "docker"the runtime to use, either docker or podman
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 test-blueprint --src DIR_PATH
func (m *myModule) example(ctx context.Context, src *Directory)   {
	return dag.
			Jumppad().
			TestBlueprint(ctx, src)
}
@function
async def example(src: dagger.Directory) -> None:
	return await (
		dag.jumppad()
		.test_blueprint(src)
	)
@func()
async example(src: Directory): Promise<void> {
	return dag
		.jumppad()
		.testBlueprint(src)
}

testBlueprintWithVersion()

TestBlueprintWithVersion tests a blueprint with a specific version of jumppad installed from GitHub releases

example usage: “dagger call test-blueprint-with-version –src ./examples/multiple_k3s_clusters –version v0.5.59”

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-the directory containing the blueprint to test
versionString !-the version of jumppad to install
workingDirectoryString "amd64"the working directory to run the test in, this is relative to the src directory
architectureString -the architecture to test the blueprint on, i.e. amd64, arm64.
runtimeString "docker"the runtime to use, either docker or podman
cacheString -the cache volume to use
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 test-blueprint-with-version --src DIR_PATH --version string
func (m *myModule) example(ctx context.Context, src *Directory, version string)   {
	return dag.
			Jumppad().
			TestBlueprintWithVersion(ctx, src, version)
}
@function
async def example(src: dagger.Directory, version: str) -> None:
	return await (
		dag.jumppad()
		.test_blueprint_with_version(src, version)
	)
@func()
async example(src: Directory, version: string): Promise<void> {
	return dag
		.jumppad()
		.testBlueprintWithVersion(src, version)
}

testBlueprintWithBinary()

TestBlueprintWithVersion tests a blueprint with an existing binary

example usage: “dagger call test-blueprint-with-binary –src ./examples/multiple_k3s_clusters –binary $(which jumppad)

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-the directory containing the blueprint to test
binaryFile !-the path to the jumppad binary
workingDirectoryString -the working directory to run the test in, this is relative to the src directory
architectureString "amd64"the architecture to test the blueprint on, i.e. amd64, arm64.
runtimeString "docker"the runtime to use, either docker or podman
cacheString -No description provided
Example
dagger -m github.com/jumppad-labs/daggerverse/jumppad@b818a297c78f559e95190a1a19a30668abdd996f call \
 test-blueprint-with-binary --src DIR_PATH --binary file:path
func (m *myModule) example(ctx context.Context, src *Directory, binary *File)   {
	return dag.
			Jumppad().
			TestBlueprintWithBinary(ctx, src, binary)
}
@function
async def example(src: dagger.Directory, binary: dagger.File) -> None:
	return await (
		dag.jumppad()
		.test_blueprint_with_binary(src, binary)
	)
@func()
async example(src: Directory, binary: File): Promise<void> {
	return dag
		.jumppad()
		.testBlueprintWithBinary(src, binary)
}