interlink
Installation
Entrypoint
Types
Interlink

interlink

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

Installation

dagger install github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517

Entrypoint

Return Type

Interlink !

Arguments

Name	Type	Description
name	String !	No description provided
virtualKubeletRef	String	No description provided
interlinkRef	String	No description provided

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string

func (m *myModule) example(name string) *Interlink  {
	return dag.
			Interlink(name)
}

@function
def example(name: str, ) -> dag.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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string registry

func (m *myModule) example(name string) *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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string manifests

func (m *myModule) example(name string) *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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 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()
}

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
pluginImage	String	"dciangot/docker-plugin:v1"	No description provided
pluginEndpoint	Service	-	No description provided
pluginConfig	File	-	No description provided

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string new-interlink --manifests DIR_PATH

func (m *myModule) example(name string, manifests *Directory) *Interlink  {
	return dag.
			Interlink(name).
			NewInterlink(manifests)
}

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

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

config() 🔗

Returns the kubeconfig file of the k3s cluster

Return Type

File !

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string config

func (m *myModule) example(name string) *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/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string build-images --source-folder DIR_PATH

func (m *myModule) example(name string, sourceFolder *Directory) *Interlink  {
	return dag.
			Interlink(name).
			BuildImages(sourceFolder)
}

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

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

kube() 🔗

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

Return Type

Service !

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string kube

func (m *myModule) example(name string) *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 !

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string run

func (m *myModule) example(name string) *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()
}

test() 🔗

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

Return Type

Container !

Arguments

Name	Type	Default Value	Description
localCluster	Service	-	No description provided

Example

dagger -m github.com/interTwin-eu/interLink/ci@147b59e1dddf8a8c7d6f5d645cf5e814c6f03517 call \
 --name string test

func (m *myModule) example(name string) *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()
}