harbor-satellite
Installation
Entrypoint
Types
HarborSatellite

harbor-satellite

No long description provided.

Installation

dagger install github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b

Entrypoint

Return Type

HarborSatellite

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \

func (m *myModule) example() *HarborSatellite  {
	return dag.
			HarborSatellite()
}

@function
def example() -> dag.HarborSatellite:
	return (
		dag.harbor_satellite()
	)

@func()
example(): HarborSatellite {
	return dag
		.harborSatellite()
}

Types

HarborSatellite 🔗

attach() 🔗

Attach would attach a docker as a service to the container provided.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
container	Container !	-	No description provided
dockerVersion	String !	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 attach --container IMAGE:TAG --docker-version string

func (m *myModule) example(container *Container, dockerVersion string) *Container  {
	return dag.
			HarborSatellite().
			Attach(container, dockerVersion)
}

@function
def example(container: dagger.Container, docker_version: str) -> dagger.Container:
	return (
		dag.harbor_satellite()
		.attach(container, docker_version)
	)

@func()
example(container: Container, dockerVersion: string): Container {
	return dag
		.harborSatellite()
		.attach(container, dockerVersion)
}

service() 🔗

Get a Service container running dockerd

Return Type

Service !

Arguments

Name	Type	Default Value	Description
dockerVersion	String	"24.0"	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 service

func (m *myModule) example() *Service  {
	return dag.
			HarborSatellite().
			Service()
}

@function
def example() -> dagger.Service:
	return (
		dag.harbor_satellite()
		.service()
	)

@func()
example(): Service {
	return dag
		.harborSatellite()
		.service()
}

executeTestsForGroundControl() 🔗

Would execute the tests for the ground control. Source should be the path to the path to main.go file.

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 execute-tests-for-ground-control --source DIR_PATH

func (m *myModule) example(ctx context.Context, source *Directory) string  {
	return dag.
			HarborSatellite().
			ExecuteTestsForGroundControl(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.harbor_satellite()
		.execute_tests_for_ground_control(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.harborSatellite()
		.executeTestsForGroundControl(source)
}

runGroundControl() 🔗

start the dev server for ground-control.

Return Type

Service !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 run-ground-control

func (m *myModule) example() *Service  {
	return dag.
			HarborSatellite().
			RunGroundControl()
}

@function
def example() -> dagger.Service:
	return (
		dag.harbor_satellite()
		.run_ground_control()
	)

@func()
example(): Service {
	return dag
		.harborSatellite()
		.runGroundControl()
}

buildDev() 🔗

quickly build binaries for components for given platform.

Return Type

File !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided
platform	String !	-	No description provided
component	String !	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 build-dev --platform string --component string

func (m *myModule) example(platform string, component string) *File  {
	return dag.
			HarborSatellite().
			BuildDev(platform, component)
}

@function
def example(platform: str, component: str) -> dagger.File:
	return (
		dag.harbor_satellite()
		.build_dev(platform, component)
	)

@func()
example(platform: string, component: string): File {
	return dag
		.harborSatellite()
		.buildDev(platform, component)
}

db() 🔗

starts postgres DB container for ground-control.

Return Type

Service !

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 db

func (m *myModule) example() *Service  {
	return dag.
			HarborSatellite().
			Db()
}

@function
def example() -> dagger.Service:
	return (
		dag.harbor_satellite()
		.db()
	)

@func()
example(): Service {
	return dag
		.harborSatellite()
		.db()
}

build() 🔗

Build function would start the build process for the name provided. Source should be the path to the main.go file.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided
component	String !	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 build --component string

func (m *myModule) example(component string) *Directory  {
	return dag.
			HarborSatellite().
			Build(component)
}

@function
def example(component: str) -> dagger.Directory:
	return (
		dag.harbor_satellite()
		.build(component)
	)

@func()
example(component: string): Directory {
	return dag
		.harborSatellite()
		.build(component)
}

release() 🔗

Release function would release the build to the github with the tags provided. Directory should be “.” for both the satellite and the ground control.

Return Type

String !

Arguments

Name	Type	Default Value	Description
directory	Directory !	-	No description provided
token	String !	-	No description provided
name	String !	-	No description provided
releaseType	String	"patch"	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 release --directory DIR_PATH --token string --name string

func (m *myModule) example(ctx context.Context, directory *Directory, token string, name string) string  {
	return dag.
			HarborSatellite().
			Release(ctx, directory, token, name)
}

@function
async def example(directory: dagger.Directory, token: str, name: str) -> str:
	return await (
		dag.harbor_satellite()
		.release(directory, token, name)
	)

@func()
async example(directory: Directory, token: string, name: string): Promise<string> {
	return dag
		.harborSatellite()
		.release(directory, token, name)
}

executeTestsForSatellite() 🔗

Would execute the tests for the satellite. Source should be the path to the path to main.go file.

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/container-registry/harbor-satellite@4511a5b35a95b2f6102a65691d439e41aa35e52b call \
 execute-tests-for-satellite --source DIR_PATH

func (m *myModule) example(ctx context.Context, source *Directory) string  {
	return dag.
			HarborSatellite().
			ExecuteTestsForSatellite(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.harbor_satellite()
		.execute_tests_for_satellite(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.harborSatellite()
		.executeTestsForSatellite(source)
}