kind
A Dagger Module for integrating with the KinD
Installation
dagger install github.com/aweris/daggerverse/kind@v0.0.1
Entrypoint
Return Type
Kind !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
socket | Socket ! | - | Unix socket to connect to the external Docker Engine. Please carefully use this option it can expose your host to the container. |
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
func (m *myModule) example(socket *Socket) *Kind {
return dag.
Kind(socket)
}
@function
def example(socket: dag.Socket) -> dag.Kind:
return (
dag.kind(socket)
)
@func()
example(socket: Socket): Kind {
return dag
.kind(socket)
}
Types
Kind 🔗
container() 🔗
Container that contains the kind and k9s binaries
Return Type
Container !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
container
func (m *myModule) example(socket *Socket) *Container {
return dag.
Kind(socket).
Container()
}
@function
def example(socket: dag.Socket) -> dagger.Container:
return (
dag.kind(socket)
.container()
)
@func()
example(socket: Socket): Container {
return dag
.kind(socket)
.container()
}
cluster() 🔗
Returns a cluster object that can be used to interact with the kind cluster
Return Type
Cluster !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "kind" | Name of the cluster |
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster
func (m *myModule) example(socket *Socket) *KindCluster {
return dag.
Kind(socket).
Cluster()
}
@function
def example(socket: dag.Socket) -> dag.KindCluster:
return (
dag.kind(socket)
.cluster()
)
@func()
example(socket: Socket): KindCluster {
return dag
.kind(socket)
.cluster()
}
Cluster 🔗
Represents a kind cluster
name() 🔗
Name of the cluster
Return Type
String !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
name
func (m *myModule) example(ctx context.Context) string {
return dag.
Kind().
Cluster().
Name(ctx)
}
@function
async def example() -> str:
return await (
dag.kind()
.cluster()
.name()
)
@func()
async example(): Promise<string> {
return dag
.kind()
.cluster()
.name()
}
network() 🔗
Network name of the cluster. This should be the same as the network name of the dagger-engine containers
Return Type
String !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
network
func (m *myModule) example(ctx context.Context) string {
return dag.
Kind().
Cluster().
Network(ctx)
}
@function
async def example() -> str:
return await (
dag.kind()
.cluster()
.network()
)
@func()
async example(): Promise<string> {
return dag
.kind()
.cluster()
.network()
}
exist() 🔗
Check if the cluster exists or not
Return Type
Boolean !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
exist
func (m *myModule) example(ctx context.Context) bool {
return dag.
Kind().
Cluster().
Exist(ctx)
}
@function
async def example() -> bool:
return await (
dag.kind()
.cluster()
.exist()
)
@func()
async example(): Promise<boolean> {
return dag
.kind()
.cluster()
.exist()
}
create() 🔗
Create creates the cluster if it doesn’t already exist.
Return Type
String !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
create
func (m *myModule) example(ctx context.Context) string {
return dag.
Kind().
Cluster().
Create(ctx)
}
@function
async def example() -> str:
return await (
dag.kind()
.cluster()
.create()
)
@func()
async example(): Promise<string> {
return dag
.kind()
.cluster()
.create()
}
delete() 🔗
Delete deletes the cluster if it exists.
Return Type
String !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
delete
func (m *myModule) example(ctx context.Context) string {
return dag.
Kind().
Cluster().
Delete(ctx)
}
@function
async def example() -> str:
return await (
dag.kind()
.cluster()
.delete()
)
@func()
async example(): Promise<string> {
return dag
.kind()
.cluster()
.delete()
}
logs() 🔗
Exports cluster logs to a directory
Return Type
Directory !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
logs
func (m *myModule) example() *Directory {
return dag.
Kind().
Cluster().
Logs()
}
@function
def example() -> dagger.Directory:
return (
dag.kind()
.cluster()
.logs()
)
@func()
example(): Directory {
return dag
.kind()
.cluster()
.logs()
}
kubeconfig() 🔗
Exports cluster kubeconfig
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
internal | Boolean | false | If true, the internal address is used in the kubeconfig. This is useful for running kubectl commands from within other containers. |
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
kubeconfig
func (m *myModule) example() *File {
return dag.
Kind().
Cluster().
Kubeconfig()
}
@function
def example() -> dagger.File:
return (
dag.kind()
.cluster()
.kubeconfig()
)
@func()
example(): File {
return dag
.kind()
.cluster()
.kubeconfig()
}
container() 🔗
Container that contains the kind and k9s binaries with the cluster name and network set as environment variables
Return Type
Container !
Example
dagger -m github.com/aweris/daggerverse/kind@2e89d21b03b7a4d59d17b99db4232f935e89f005 call \
cluster \
container
func (m *myModule) example() *Container {
return dag.
Kind().
Cluster().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.kind()
.cluster()
.container()
)
@func()
example(): Container {
return dag
.kind()
.cluster()
.container()
}