interlink

Visit the interLink documentation for more info: https://interlink-hq.github.io/interLink/docs/intro/

Installation

dagger install github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7

Entrypoint

Return Type

Interlink !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
virtualKubeletRef	String	"ghcr.io/interlink-hq/interlink/virtual-kubelet-inttw:0.4.0"	No description provided
interlinkRef	String	"ghcr.io/interlink-hq/interlink/interlink:0.4.0"	No description provided
pluginRef	String	"ghcr.io/interlink-hq/interlink-sidecar-slurm/interlink-sidecar-slurm:0.5.0"	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string

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

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

@func()
example(name: string, ): Interlink {
	return dag
		.interlink(name)
}

Types

Interlink 🔗

Interlink struct for initialization and internal variables

name() 🔗

Return Type

String !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string name

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Interlink(name).
			Name(ctx)
}

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

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

registry() 🔗

Return Type

Service !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string registry

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

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

@func()
example(name: string, ): Service {
	return dag
		.interlink(name)
		.registry()
}

manifests() 🔗

Return Type

Directory !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string manifests

func (m *MyModule) Example(name string) *dagger.Directory  {
	return dag.
			Interlink(name).
			Manifests()
}

@function
def example(name: str, ) -> dagger.Directory:
	return (
		dag.interlink(name)
		.manifests()
	)

@func()
example(name: string, ): Directory {
	return dag
		.interlink(name)
		.manifests()
}

virtualKubeletRef() 🔗

Return Type

String !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string virtual-kubelet-ref

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Interlink(name).
			VirtualKubeletRef(ctx)
}

@function
async def example(name: str, ) -> str:
	return await (
		dag.interlink(name)
		.virtual_kubelet_ref()
	)

@func()
async example(name: string, ): Promise<string> {
	return dag
		.interlink(name)
		.virtualKubeletRef()
}

interlinkRef() 🔗

Return Type

String !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string interlink-ref

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Interlink(name).
			InterlinkRef(ctx)
}

@function
async def example(name: str, ) -> str:
	return await (
		dag.interlink(name)
		.interlink_ref()
	)

@func()
async example(name: string, ): Promise<string> {
	return dag
		.interlink(name)
		.interlinkRef()
}

pluginRef() 🔗

Return Type

String !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string plugin-ref

func (m *MyModule) Example(ctx context.Context, name string) string  {
	return dag.
			Interlink(name).
			PluginRef(ctx)
}

@function
async def example(name: str, ) -> str:
	return await (
		dag.interlink(name)
		.plugin_ref()
	)

@func()
async example(name: string, ): Promise<string> {
	return dag
		.interlink(name)
		.pluginRef()
}

kubectl() 🔗

Return Type

Container !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string kubectl

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

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

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

kubeApis() 🔗

Return Type

Service !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string kube-apis

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

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

@func()
example(name: string, ): Service {
	return dag
		.interlink(name)
		.kubeApis()
}

kubeConfig() 🔗

Return Type

File !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string kube-config

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

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

@func()
example(name: string, ): File {
	return dag
		.interlink(name)
		.kubeConfig()
}

interlinkContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string interlink-container

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.interlinkContainer()
}

vkcontainer() 🔗

Return Type

Container !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string vkcontainer

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.vkcontainer()
}

pluginContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string plugin-container

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.pluginContainer()
}

newInterlink() 🔗

Setup k8s e interlink components: virtual kubelet and interlink API server

Return Type

Interlink !

Arguments

Name	Type	Default Value	Description
manifests	Directory	-	No description provided
kubeconfig	File	-	No description provided
localRegistry	Service	-	No description provided
localCluster	Service	-	No description provided
interlinkEndpoint	Service	-	No description provided
interlinkConfig	File	-	No description provided
pluginEndpoint	Service	-	No description provided
pluginConfig	File	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string new-interlink

func (m *MyModule) Example(name string) *dagger.Interlink  {
	return dag.
			Interlink(name).
			NewInterlink()
}

@function
def example(name: str, ) -> dagger.Interlink:
	return (
		dag.interlink(name)
		.new_interlink()
	)

@func()
example(name: string, ): Interlink {
	return dag
		.interlink(name)
		.newInterlink()
}

newInterlinkMtls() 🔗

NewInterlinkMTLS sets up interLink components with mTLS enabled for testing

Return Type

Interlink !

Arguments

Name	Type	Default Value	Description
manifests	Directory	-	No description provided
kubeconfig	File	-	No description provided
localRegistry	Service	-	No description provided
localCluster	Service	-	No description provided
interlinkEndpoint	Service	-	No description provided
pluginEndpoint	Service	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string new-interlink-mtls

func (m *MyModule) Example(name string) *dagger.Interlink  {
	return dag.
			Interlink(name).
			NewInterlinkMtls()
}

@function
def example(name: str, ) -> dagger.Interlink:
	return (
		dag.interlink(name)
		.new_interlink_mtls()
	)

@func()
example(name: string, ): Interlink {
	return dag
		.interlink(name)
		.newInterlinkMtls()
}

config() 🔗

Returns the kubeconfig file of the k3s cluster

Return Type

File !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string config

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

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

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

buildImages() 🔗

Build interLink and virtual kubelet docker images from source and publish them in registry service

Return Type

Interlink !

Arguments

Name	Type	Default Value	Description
virtualKubeletRef	String	"registry:5000/virtual-kubelet-inttw"	No description provided
interlinkRef	String	"registry:5000/interlink"	No description provided
pluginRef	String	"registry:5000/plugin-test"	No description provided
sourceFolder	Directory	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string build-images

func (m *MyModule) Example(name string) *dagger.Interlink  {
	return dag.
			Interlink(name).
			BuildImages()
}

@function
def example(name: str, ) -> dagger.Interlink:
	return (
		dag.interlink(name)
		.build_images()
	)

@func()
example(name: string, ): Interlink {
	return dag
		.interlink(name)
		.buildImages()
}

kube() 🔗

Wait for virtual node to be ready and expose the k8s endpoint as a service

Return Type

Service !

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string kube

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

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

@func()
example(name: string, ): Service {
	return dag
		.interlink(name)
		.kube()
}

run() 🔗

Wait for cluster to be ready, then setup the test container

Return Type

Container !

Arguments

Name	Type	Default Value	Description
manifests	Directory	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string run

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.run()
}

lint() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
sourceFolder	Directory	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string lint

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.lint()
}

test() 🔗

Wait for cluster to be ready, setup the test container, run all tests

Return Type

Container !

Arguments

Name	Type	Default Value	Description
manifests	Directory	-	No description provided
localCluster	Service	-	No description provided
sourceFolder	Directory	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string test

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.test()
}

testMtls() 🔗

TestMTLS specifically tests mTLS functionality including getLogs endpoint

Return Type

Container !

Arguments

Name	Type	Default Value	Description
manifests	Directory	-	No description provided
localCluster	Service	-	No description provided
sourceFolder	Directory	-	No description provided

Example

dagger -m github.com/interlink-hq/interLink/ci@9ed14a4e89d501f2c591856b4303a06b6efd61e7 call \
 --name string test-mtls

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

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

@func()
example(name: string, ): Container {
	return dag
		.interlink(name)
		.testMtls()
}