kube

package

v1.5.2 Latest Latest Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package kube contains some tools to setup and use a Kind cluster

This section is empty.

This section is empty.

This section is empty.

type Kind struct {
	// contains filtered or unexported fields
}

Kind cluster deployed by each TestMain function, prepared to run a given test scenario.

func NewKind(kindClusterName string, options ...Option) *Kind

NewKind creates a kind cluster given a name and set of Option instances.

func (k *Kind) Run(m *testing.M)

Run the Kind cluster for the later execution of tests.

func (k *Kind) TestEnv() env.Environment

TestEnv returns the env.Environment object, useful for unit tests that need to interact with the Kubernetes API.

type Option func(k *Kind)

Option that can be passed to the NewKind function in order to change the configuration of the test cluster

func Deploy(manifest string) Option

Deploy can be passed to NewKind to deploy extra components, in addition to the base deployment.

func ExportLogs(folder string) Option

ExportLogs can be passed to NewKind to specify the folder where the kubernetes logs will be exported after the tests.

func KindConfig(filePath string) Option

KindConfig can be passed to NewKind to override the default Kind cluster configuration.

func LocalImage(nameTag string) Option

LocalImage is passed to NewKind to allow loading a local Docker image into the cluster

func Timeout(t time.Duration) Option

Timeout for long-running operations (e.g. deployments, readiness probes...)

type Template[T any] struct {
	TemplateFile string
	Data         T
	// contains filtered or unexported fields
}

Template allows creating and deploying a K8s manifest from a Go template

func (tm *Template[T]) Delete() features.Func

func (tm *Template[T]) Deploy() features.Func