Dagger
Search

kcp

Runs a kcp server than can be accessed both locally and in your pipelines

Installation

dagger install github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3

Entrypoint

Return Type 
Kcp !
Arguments
NameTypeDefault ValueDescription
versionString "0.28.1"The kcp version to use.
opensslImageString "alpine/openssl:latest"The openssl image to use for generating certificates.
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \

func (m *MyModule) Example() *dagger.Kcp  {
	return dag.
			Kcp()
}
@function
def example() -> dagger.Kcp:
	return (
		dag.kcp()
	)
@func()
example(): Kcp {
	return dag
		.kcp()
}

Types

Kcp 🔗

version() 🔗

The kcp version.

Return Type 
String !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 version
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Kcp().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.kcp()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.kcp()
		.version()
}

clientCaCertificate() 🔗

The generated client CA certificate.

Return Type 
File !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 client-ca-certificate
func (m *MyModule) Example() *dagger.File  {
	return dag.
			Kcp().
			ClientCaCertificate()
}
@function
def example() -> dagger.File:
	return (
		dag.kcp()
		.client_ca_certificate()
	)
@func()
example(): File {
	return dag
		.kcp()
		.clientCaCertificate()
}

clientCaKey() 🔗

The generated client CA private key.

Return Type 
File !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 client-ca-key
func (m *MyModule) Example() *dagger.File  {
	return dag.
			Kcp().
			ClientCaKey()
}
@function
def example() -> dagger.File:
	return (
		dag.kcp()
		.client_ca_key()
	)
@func()
example(): File {
	return dag
		.kcp()
		.clientCaKey()
}

clientCertificate() 🔗

The generated client certificate for kcp-admin.

Return Type 
File !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 client-certificate
func (m *MyModule) Example() *dagger.File  {
	return dag.
			Kcp().
			ClientCertificate()
}
@function
def example() -> dagger.File:
	return (
		dag.kcp()
		.client_certificate()
	)
@func()
example(): File {
	return dag
		.kcp()
		.clientCertificate()
}

clientCertificateKey() 🔗

The generated client certificate private key for kcp-admin.

Return Type 
File !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 client-certificate-key
func (m *MyModule) Example() *dagger.File  {
	return dag.
			Kcp().
			ClientCertificateKey()
}
@function
def example() -> dagger.File:
	return (
		dag.kcp()
		.client_certificate_key()
	)
@func()
example(): File {
	return dag
		.kcp()
		.clientCertificateKey()
}

server() 🔗

Returns a kcp server container.

Return Type 
Container !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 server
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Kcp().
			Server()
}
@function
def example() -> dagger.Container:
	return (
		dag.kcp()
		.server()
	)
@func()
example(): Container {
	return dag
		.kcp()
		.server()
}

config() 🔗

Returns the kcp-admin kubeconfig.

Return Type 
File !
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 config
func (m *MyModule) Example() *dagger.File  {
	return dag.
			Kcp().
			Config()
}
@function
def example() -> dagger.File:
	return (
		dag.kcp()
		.config()
	)
@func()
example(): File {
	return dag
		.kcp()
		.config()
}

client() 🔗

Returns a kcp client container with the kcp plugins and the kcp-admin kubeconfig.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
platformString "linux"The system platform (should always be "linux").
archString "amd64"The system architecture (should be "amd64" or "arm64")
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 client
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Kcp().
			Client()
}
@function
def example() -> dagger.Container:
	return (
		dag.kcp()
		.client()
	)
@func()
example(): Container {
	return dag
		.kcp()
		.client()
}

withWorkspaces() 🔗

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
platformString "linux"The system platform (should always be "linux").
archString "amd64"The system architecture (should be "amd64" or "arm64")
rootDirectory -The directory tree to bootstrap in kcp.
Example
dagger -m github.com/orvis98/daggerverse/kcp@6a5481883a625b08b2dda9737bf715351db0e9b3 call \
 with-workspaces
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Kcp().
			WithWorkspaces()
}
@function
def example() -> dagger.Container:
	return (
		dag.kcp()
		.with_workspaces()
	)
@func()
example(): Container {
	return dag
		.kcp()
		.withWorkspaces()
}