kind
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956
Entrypoint
Return Type
Kind !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
version | String | "latest" | the desired kind version |
dockerSocket | Socket ! | - | path to the host Docker socket |
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
func (m *myModule) example(dockerSocket *Socket) *Kind {
return dag.
Kind(dockerSocket)
}
@function
def example(docker_socket: dag.Socket) -> dag.Kind:
return (
dag.kind(docker_socket)
)
@func()
example(dockerSocket: Socket): Kind {
return dag
.kind(dockerSocket)
}
Types
Kind 🔗
container() 🔗
Container with the kind and docker binaries
Return Type
Container !
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
container
func (m *myModule) example(dockerSocket *Socket) *Container {
return dag.
Kind(dockerSocket).
Container()
}
@function
def example(docker_socket: dag.Socket) -> dagger.Container:
return (
dag.kind(docker_socket)
.container()
)
@func()
example(dockerSocket: Socket): Container {
return dag
.kind(dockerSocket)
.container()
}
version() 🔗
Prints the kind CLI version
Return Type
String !
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
version
func (m *myModule) example(ctx context.Context, dockerSocket *Socket) string {
return dag.
Kind(dockerSocket).
Version(ctx)
}
@function
async def example(docker_socket: dag.Socket) -> str:
return await (
dag.kind(docker_socket)
.version()
)
@func()
async example(dockerSocket: Socket): Promise<string> {
return dag
.kind(dockerSocket)
.version()
}
getClusters() 🔗
Lists existing kind clusters by their name
Return Type
String !
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
get-clusters
func (m *myModule) example(ctx context.Context, dockerSocket *Socket) string {
return dag.
Kind(dockerSocket).
GetClusters(ctx)
}
@function
async def example(docker_socket: dag.Socket) -> str:
return await (
dag.kind(docker_socket)
.get_clusters()
)
@func()
async example(dockerSocket: Socket): Promise<string> {
return dag
.kind(dockerSocket)
.getClusters()
}
createCluster() 🔗
Creates a local Kubernetes cluster
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "kind" | cluster name, overrides KIND_CLUSTER_NAME, config |
config | File | - | path to a kind config file |
image | String | - | node docker image to use for booting the cluster |
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
create-cluster
func (m *myModule) example(ctx context.Context, dockerSocket *Socket) string {
return dag.
Kind(dockerSocket).
CreateCluster(ctx)
}
@function
async def example(docker_socket: dag.Socket) -> str:
return await (
dag.kind(docker_socket)
.create_cluster()
)
@func()
async example(dockerSocket: Socket): Promise<string> {
return dag
.kind(dockerSocket)
.createCluster()
}
deleteCluster() 🔗
Deletes a cluster
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "kind" | the cluster name |
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
delete-cluster
func (m *myModule) example(ctx context.Context, dockerSocket *Socket) string {
return dag.
Kind(dockerSocket).
DeleteCluster(ctx)
}
@function
async def example(docker_socket: dag.Socket) -> str:
return await (
dag.kind(docker_socket)
.delete_cluster()
)
@func()
async example(dockerSocket: Socket): Promise<string> {
return dag
.kind(dockerSocket)
.deleteCluster()
}
kubeconfig() 🔗
Exports cluster kubeconfig
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "kind" | the cluster name |
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
kubeconfig
func (m *myModule) example(dockerSocket *Socket) *File {
return dag.
Kind(dockerSocket).
Kubeconfig()
}
@function
def example(docker_socket: dag.Socket) -> dagger.File:
return (
dag.kind(docker_socket)
.kubeconfig()
)
@func()
example(dockerSocket: Socket): File {
return dag
.kind(dockerSocket)
.kubeconfig()
}
logs() 🔗
Exports logs to a directory
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "kind" | the cluster name |
Example
dagger -m github.com/orvis98/daggerverse/kind@0084f3cd2a700b5c3f12464632c135a1d1cb7956 call \
logs
func (m *myModule) example(dockerSocket *Socket) *Directory {
return dag.
Kind(dockerSocket).
Logs()
}
@function
def example(docker_socket: dag.Socket) -> dagger.Directory:
return (
dag.kind(docker_socket)
.logs()
)
@func()
example(dockerSocket: Socket): Directory {
return dag
.kind(dockerSocket)
.logs()
}