controlplane

package
v2.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 25, 2026 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Overview

Package controlplane manages local development control planes.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func TeardownLocalDevControlPlane

func TeardownLocalDevControlPlane(ctx context.Context, name string, registryDir string) error

TeardownLocalDevControlPlane tears down a local dev control plane by name. It deletes the kind cluster, stops the registry container, and removes the registry data directory.

Types

type DevControlPlane

type DevControlPlane interface {
	// Info returns human-friendly information about the control plane.
	Info() string
	// Client returns a controller-runtime client for the control plane.
	Client() client.Client
	// Kubeconfig returns a kubeconfig for the control plane.
	Kubeconfig() clientcmd.ClientConfig
	// Teardown tears down the control plane, deleting any resources it may use.
	Teardown(ctx context.Context) error
	// Sideload sideloads packages into the control plane.
	Sideload(ctx context.Context, imgMap project.ImageTagMap, tag name.Tag) error
}

DevControlPlane is a local development control plane.

func EnsureLocalDevControlPlane

func EnsureLocalDevControlPlane(ctx context.Context, opts ...Option) (DevControlPlane, error)

EnsureLocalDevControlPlane creates or reuses a local kind-based development control plane with Crossplane installed.

type Option

type Option func(*config)

Option configures EnsureLocalDevControlPlane.

func WithClusterAdmin

func WithClusterAdmin(enabled bool) Option

WithClusterAdmin sets whether to grant Crossplane cluster admin privileges.

func WithCrossplaneVersion

func WithCrossplaneVersion(v string) Option

WithCrossplaneVersion sets the Crossplane version to install.

func WithLogger

func WithLogger(l logging.Logger) Option

WithLogger sets the logger for progress updates.

func WithName

func WithName(n string) Option

WithName sets the name of the local dev control plane.

func WithRegistryDir

func WithRegistryDir(d string) Option

WithRegistryDir sets the directory for local registry images.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL