kind
No long description provided.
Installation
dagger install github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fbEntrypoint
Return Type
Kind !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| dockerSocket | Socket ! | - | Docker socket path. E.g. /var/run/docker.sock How to use it: dagger call --docker-socket=/var/run/docker.sock --kind-svc=tcp://127.0.0.1:3000 |
| kindSvc | Service ! | - | It should be the tcp://127.0.0.1 followed by any port. E.g. tcp://127.0.0.1:3000 Before launch this function, make sure that you have configured in your /etc/hosts file an entry for localhost 127.0.0.1 . Otherwise, the alpine container will not be able to connect to the kind cluster. |
| kind | String | - | The Kind version you want to use. check https://github.com/kubernetes-sigs/kind/releases E.g.: "v0.25.0" |
| kindSha | String | - | The Kubernetes version you want to use. This must be specified only when the kind version is also specified. check https://github.com/kubernetes-sigs/kind/releases NOTE: This takes preference over the `version` field. E.g.: "kindest/node:v1.26.15@sha256:c79602a44b4056d7e48dc20f7504350f1e87530fe953428b792def00bc1076dd" |
| version | Enum | - | The Kubernetes version you want to use inside the cluster. Must be one of the available versions of the current Kind version used (which default is v0.25.0). It has to be indicated like "vx.y", being 'x' the major and 'y' the minor versions. check https://github.com/kubernetes-sigs/kind/releases |
| clusterName | String | "dagger-kubernetes-cluster" | The name of the kind cluster |
| configFile | File | - | A custom configuration file for kind. If set, it is mandatory to indicate `networking.apiServerPort`, with the port of `kindSvc` as value E.g. with the `kindSvc` example: networking: apiServerPort: 3000 |
Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORTfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Kind {
return dag.
Kind(dockerSocket, kindSvc)
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Kind:
return (
dag.kind(docker_socket, kind_svc)
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Kind {
return dag
.kind(dockerSocket, kindSvc)
}Types
Kind 🔗
dockerSocket() 🔗
Return Type
Socket ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT docker-socketfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Socket {
return dag.
Kind(dockerSocket, kindSvc).
DockerSocket()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Socket:
return (
dag.kind(docker_socket, kind_svc)
.docker_socket()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Socket {
return dag
.kind(dockerSocket, kindSvc)
.dockerSocket()
}kindSvc() 🔗
Return Type
Service ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT kind-svcfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Service {
return dag.
Kind(dockerSocket, kindSvc).
KindSvc()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Service:
return (
dag.kind(docker_socket, kind_svc)
.kind_svc()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Service {
return dag
.kind(dockerSocket, kindSvc)
.kindSvc()
}kindPort() 🔗
Return Type
Integer ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT kind-portfunc (m *MyModule) Example(ctx context.Context, dockerSocket *dagger.Socket, kindSvc *dagger.Service) int {
return dag.
Kind(dockerSocket, kindSvc).
KindPort(ctx)
}@function
async def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> int:
return await (
dag.kind(docker_socket, kind_svc)
.kind_port()
)@func()
async example(dockerSocket: Socket, kindSvc: Service, ): Promise<number> {
return dag
.kind(dockerSocket, kindSvc)
.kindPort()
}container() 🔗
Return Type
Container ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT containerfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Container {
return dag.
Kind(dockerSocket, kindSvc).
Container()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Container:
return (
dag.kind(docker_socket, kind_svc)
.container()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Container {
return dag
.kind(dockerSocket, kindSvc)
.container()
}clusterName() 🔗
Return Type
String ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT cluster-namefunc (m *MyModule) Example(ctx context.Context, dockerSocket *dagger.Socket, kindSvc *dagger.Service) string {
return dag.
Kind(dockerSocket, kindSvc).
ClusterName(ctx)
}@function
async def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> str:
return await (
dag.kind(docker_socket, kind_svc)
.cluster_name()
)@func()
async example(dockerSocket: Socket, kindSvc: Service, ): Promise<string> {
return dag
.kind(dockerSocket, kindSvc)
.clusterName()
}configFile() 🔗
Return Type
File ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT config-filefunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.File {
return dag.
Kind(dockerSocket, kindSvc).
ConfigFile()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.File:
return (
dag.kind(docker_socket, kind_svc)
.config_file()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): File {
return dag
.kind(dockerSocket, kindSvc)
.configFile()
}loadContainerOnKind() 🔗
Loads a container to kind cluster, previously it was saved as a tarball with the annotations required by kind. You can use this function into your module
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| container | Container ! | - | No description provided |
| tag | String ! | - | No description provided |
Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT load-container-on-kind --container IMAGE:TAG --tag stringfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service, container *dagger.Container, tag string) *dagger.Container {
return dag.
Kind(dockerSocket, kindSvc).
LoadContainerOnKind(container, tag)
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, container: dagger.Container, tag: str) -> dagger.Container:
return (
dag.kind(docker_socket, kind_svc)
.load_container_on_kind(container, tag)
)@func()
example(dockerSocket: Socket, kindSvc: Service, container: Container, tag: string): Container {
return dag
.kind(dockerSocket, kindSvc)
.loadContainerOnKind(container, tag)
}knines() 🔗
Launch k9s terminal Example usage: dagger call –docker-socket=/var/run/docker.sock –kind-svc=tcp://127.0.0.1:3000 knines
Return Type
Container ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT kninesfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Container {
return dag.
Kind(dockerSocket, kindSvc).
Knines()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Container:
return (
dag.kind(docker_socket, kind_svc)
.knines()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Container {
return dag
.kind(dockerSocket, kindSvc)
.knines()
}inspect() 🔗
Inspect returns the container that will be launched Example usage: dagger call –docker-socket=/var/run/docker.sock –kind-svc=tcp://127.0.0.1:3000 inspect
Return Type
Container ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT inspectfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Container {
return dag.
Kind(dockerSocket, kindSvc).
Inspect()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Container:
return (
dag.kind(docker_socket, kind_svc)
.inspect()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Container {
return dag
.kind(dockerSocket, kindSvc)
.inspect()
}test() 🔗
Inspect returns the container that will be launched Example usage: dagger call –docker-socket=/var/run/docker.sock –kind-svc=tcp://127.0.0.1:3000 inspect
Return Type
Container ! Example
dagger -m github.com/prefapp/daggerverse/kind@ddec1a45615a82f16d3f49d58c958b2a0338d1fb call \
--kind-svc PROTOCOL://HOST:PORT testfunc (m *MyModule) Example(dockerSocket *dagger.Socket, kindSvc *dagger.Service) *dagger.Container {
return dag.
Kind(dockerSocket, kindSvc).
Test()
}@function
def example(docker_socket: dagger.Socket, kind_svc: dagger.Service, ) -> dagger.Container:
return (
dag.kind(docker_socket, kind_svc)
.test()
)@func()
example(dockerSocket: Socket, kindSvc: Service, ): Container {
return dag
.kind(dockerSocket, kindSvc)
.test()
}