k3s
Runs a k3s server than can be accessed both locally and in your pipelines
Installation
dagger install github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854Entrypoint
Return Type
K3S !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| name | String ! | - | No description provided |
| image | String | "rancher/k3s:latest" | No description provided |
Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name stringfunc (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)
}Types
K3S 🔗
container() 🔗
Return Type
Container ! Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string containerfunc (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()
}server() 🔗
Returns a newly initialized kind cluster
Return Type
Service !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| clusterCidr | String | - | Alternative cluster CIDR. It needed when dagger run inside rancher |
| serviceCird | String | - | Alternative service CIDR. It needed when dagger run inside rancher |
Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string serverfunc (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()
}withContainer() 🔗
Returns a newly initialized kind cluster
Return Type
K3S !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| c | Container ! | - | No description provided |
Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string with-container --c IMAGE:TAGfunc (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)
}config() 🔗
returns the config file for the k3s cluster
Return Type
File !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| local | Boolean | false | No description provided |
Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string configfunc (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()
}kubectl() 🔗
runs kubectl on the target k3s cluster
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| args | String ! | - | No description provided |
Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string kubectl --args stringfunc (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)
}kns() 🔗
runs k9s on the target k3s cluster
Return Type
Container ! Example
dagger -m github.com/disaster37/dagger-library-go/k3s@973aa50d7915782c6623963ea5e9d75cfc0b5854 call \
--name string knsfunc (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()
}