cluster

package
v1.7.0 Latest Latest
Warning

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

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

Documentation

Overview

Package cluster defines the local-Kubernetes driver abstraction. v1.1 ships with the k3d driver; future drivers (kind) implement the same interface.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Driver

type Driver interface {
	// Name returns a stable cluster name used by Ensure/Delete.
	Name() string

	// Ensure creates the cluster if missing. No-op if already present.
	// Writes kubeconfig to the path returned by Kubeconfig() once Ensure returns nil.
	Ensure(ctx context.Context) error

	// Status reports whether the cluster currently exists and is running.
	Status(ctx context.Context) (Status, error)

	// Delete removes the cluster. No-op if absent.
	Delete(ctx context.Context) error

	// Kubeconfig returns the path the driver writes the cluster's kubeconfig to.
	Kubeconfig() string
}

Driver manages the lifecycle of a local cluster.

type Status

type Status struct {
	Exists  bool
	Running bool
	Detail  string
}

Directories

Path Synopsis
Package k3d implements cluster.Driver by shelling out to the k3d binary.
Package k3d implements cluster.Driver by shelling out to the k3d binary.
Package tekton installs the Tekton Pipelines controller into a Kubernetes cluster.
Package tekton installs the Tekton Pipelines controller into a Kubernetes cluster.

Jump to

Keyboard shortcuts

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