Dagger
Search

xk6

Build k6 with extensions.

Installation

dagger install github.com/sagikazarmark/daggerverse/xk6@833905febeb1c77937712dd9f69a2c85898c74d9

Entrypoint

Return Type
Xk6 !
Arguments
NameTypeDescription
versionString Version (image tag) to use from the official image repository as a base container.
imageString Custom image reference in "repository:tag" format to use as a base container.
containerContainer Custom container to use as a base container.
Example
func (m *myModule) example() *Xk6  {
	return dag.
			Xk6()
}
@function
def example() -> dag.Xk6:
	return (
		dag.xk6()
	)
@func()
example(): Xk6 {
	return dag
		.xk6()
}

Types

Xk6

container()

Return Type
Container !
Example
dagger -m github.com/sagikazarmark/daggerverse/xk6@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 container
func (m *myModule) example() *Container  {
	return dag.
			Xk6().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.xk6()
		.container()
	)
@func()
example(): Container {
	return dag
		.xk6()
		.container()
}

withPlatform()

Set GOOS, GOARCH and GOARM environment variables.

Return Type
Xk6 !
Arguments
NameTypeDefault ValueDescription
platformString !-Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").
Example
dagger -m github.com/sagikazarmark/daggerverse/xk6@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 with-platform --platform string \
 container
func (m *myModule) example(platform string) *Xk6  {
	return dag.
			Xk6().
			WithPlatform(platform)
}
@function
def example(platform: str) -> dag.Xk6:
	return (
		dag.xk6()
		.with_platform(platform)
	)
@func()
example(platform: string): Xk6 {
	return dag
		.xk6()
		.withPlatform(platform)
}

build()

Build a custom k6 binary.

Return Type
File !
Arguments
NameTypeDefault ValueDescription
versionString -k6 version to build (default: "latest")
with[String ! ] -Extension to add to the k6 binary (format: <module[@version][=replacement]>)
replace[String ! ] -Add replacements to the go.mod file generated (format: <module=replacement>)
platformString -Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").
Example
dagger -m github.com/sagikazarmark/daggerverse/xk6@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 build
func (m *myModule) example() *File  {
	return dag.
			Xk6().
			Build()
}
@function
def example() -> dagger.File:
	return (
		dag.xk6()
		.build()
	)
@func()
example(): File {
	return dag
		.xk6()
		.build()
}