k3s

Runs a k3s server than can be accessed both locally and in your pipelines

Installation

dagger install github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749

K3S !

Name	Type	Default Value	Description
name	String !	-	No description provided
image	String	"rancher/k3s:latest"	No description provided
keepState	Boolean	"false"	keeps the state of the cluster (not recommended).

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string

func (m *MyModule) Example(name string) *dagger.K3S  {
	return dag.
			K3s(name)
}

@function
def example(name: str, ) -> dagger.K3S:
	return (
		dag.k3s(name)
	)

@func()
example(name: string, ): K3S {
	return dag
		.k3s(name)
}

Container !

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string container

func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			K3s(name).
			Container()
}

@function
def example(name: str, ) -> dagger.Container:
	return (
		dag.k3s(name)
		.container()
	)

@func()
example(name: string, ): Container {
	return dag
		.k3s(name)
		.container()
}

Integer !

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string port

func (m *MyModule) Example(ctx context.Context, name string) int  {
	return dag.
			K3s(name).
			Port(ctx)
}

@function
async def example(name: str, ) -> int:
	return await (
		dag.k3s(name)
		.port()
	)

@func()
async example(name: string, ): Promise<number> {
	return dag
		.k3s(name)
		.port()
}

Returns a newly initialized kind cluster

Service !

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string server

func (m *MyModule) Example(name string) *dagger.Service  {
	return dag.
			K3s(name).
			Server()
}

@function
def example(name: str, ) -> dagger.Service:
	return (
		dag.k3s(name)
		.server()
	)

@func()
example(name: string, ): Service {
	return dag
		.k3s(name)
		.server()
}

Returns a newly initialized kind cluster

K3S !

Name	Type	Default Value	Description
c	Container !	-	No description provided

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string with-container --c IMAGE:TAG

func (m *MyModule) Example(name string, c *dagger.Container) *dagger.K3S  {
	return dag.
			K3s(name).
			WithContainer(c)
}

@function
def example(name: str, c: dagger.Container) -> dagger.K3S:
	return (
		dag.k3s(name)
		.with_container(c)
	)

@func()
example(name: string, c: Container): K3S {
	return dag
		.k3s(name)
		.withContainer(c)
}

returns the config file for the k3s cluster

File !

Name	Type	Default Value	Description
local	Boolean	false	No description provided

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string config

func (m *MyModule) Example(name string) *dagger.File  {
	return dag.
			K3s(name).
			Config()
}

@function
def example(name: str, ) -> dagger.File:
	return (
		dag.k3s(name)
		.config()
	)

@func()
example(name: string, ): File {
	return dag
		.k3s(name)
		.config()
}

runs kubectl on the target k3s cluster

Container !

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

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string kubectl --args string

func (m *MyModule) Example(name string, args string) *dagger.Container  {
	return dag.
			K3s(name).
			Kubectl(args)
}

@function
def example(name: str, args: str) -> dagger.Container:
	return (
		dag.k3s(name)
		.kubectl(args)
	)

@func()
example(name: string, args: string): Container {
	return dag
		.k3s(name)
		.kubectl(args)
}

runs k9s on the target k3s cluster

Container !

Example

dagger -m github.com/chrishham/daggerverse/k3s@5ef9d15293458380d3044541273de5d5f5169749 call \
 --name string kns

func (m *MyModule) Example(name string) *dagger.Container  {
	return dag.
			K3s(name).
			Kns()
}

@function
def example(name: str, ) -> dagger.Container:
	return (
		dag.k3s(name)
		.kns()
	)

@func()
example(name: string, ): Container {
	return dag
		.k3s(name)
		.kns()
}