envtest

package module

v0.0.0-...-f5d5267 Latest Latest Go to latest Published: Apr 17, 2019 License: Apache-2.0 Imports: 10 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

Repository

github.com/nickschuch/controller-runtime-envtest-k3s

Links

Open Source Insights

README ¶

controller-runtime-envtest-k3s

A drop in replacement for https://sigs.k8s.io/controller-runtime/pkg/envtest using https://k3s.io

Why?

sigs.k8s.io/controller-runtime/pkg/envtest uses process execution under the hood to run clusters. This uses containers to wrap those processes!
Lesss CPU and Memory overhead
Provides a full Kubernetes environment for full end-to-end tests (eg. Nodes provided)
Easier to debug fails eg. Get a session on the clusters container

Usage

The following example is taking an autogenerated test suite from the Kubebuilder project and converting it to use K3s as it's test Kubernetes cluster.

Can you spot the difference? :)

Before	After

Thankyou

This project is standing on the shoulders of giants.

K3s - Amazing project which makes it super easy to spin up Kubernetes environments.
envtest - We are still using this under the hood for some of the heavily lifting eg. Installing CRDs.

Documentation ¶

Index ¶

Constants
type Environment
- func (e *Environment) Start() (*rest.Config, error)
- func (e *Environment) Stop() error

Constants ¶

View Source

const (
	// DefaultImage which will be used if non is provided.
	DefaultImage = "docker.io/rancher/k3s:v0.4.0"
	// InsecurePort assigned to the K3s cluster.
	InsecurePort = "8080"
	// BindAddress assigned to the K3s cluster.
	BindAddress = "0.0.0.0"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Environment ¶

type Environment struct {
	// Image which will be used for spinning up K3s.
	Image string
	// CRDDirectoryPaths for preloading CustomResourceDefinitions.
	// This is field name was taken from the controller-runtime envtest package
	// for compatibility reasons.
	CRDDirectoryPaths []string
	// contains filtered or unexported fields
}

Environment which will back the Kubebuilder testsuite.

func (*Environment) Start ¶

func (e *Environment) Start() (*rest.Config, error)

Start the test environment.

func (*Environment) Stop ¶

func (e *Environment) Stop() error

Stop the test environment.

Source Files ¶

View all Source files

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