kind

package

v0.7.0 Latest Latest Go to latest Published: Sep 28, 2021 License: Apache-2.0 Imports: 15 Imported by: 7

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kong/kubernetes-testing-framework

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func New(ctx context.Context) (clusters.Cluster, error)
func NewFromExisting(name string) (clusters.Cluster, error)
type Builder
- func NewBuilder() *Builder

Constants ¶

View Source

const (
	// KindClusterType indicates that the Kubernetes cluster was provisioned by Kind.
	KindClusterType clusters.Type = "kind"

	// EnvKeepCluster is the environment variable that can be set to "true" in order
	// to circumvent teardown during cleanup of clusters in order to allow a user to inspect them instead.
	EnvKeepCluster = "KIND_KEEP_CLUSTER"

	// DefaultKindDockerNetwork is the Docker network that a kind cluster uses by default.
	DefaultKindDockerNetwork = "kind"
)

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(ctx context.Context) (clusters.Cluster, error)

New provides a new clusters.Cluster backed by a Kind based Kubernetes Cluster.

func NewFromExisting ¶

func NewFromExisting(name string) (clusters.Cluster, error)

NewFromExisting provides a Cluster object for a given kind cluster by name.

Types ¶

type Builder ¶

type Builder struct {
	Name string
	// contains filtered or unexported fields
}

Builder generates clusters.Cluster objects backed by Kind given provided configuration options.

func NewBuilder ¶

func NewBuilder() *Builder

NewBuilder provides a new *Builder object.

func (*Builder) Build ¶

func (b *Builder) Build(ctx context.Context) (clusters.Cluster, error)

Build creates and configures clients for a Kind-based Kubernetes clusters.Cluster.

func (*Builder) WithClusterVersion ¶

func (b *Builder) WithClusterVersion(version semver.Version) *Builder

WithClusterVersion configures the Kubernetes cluster version for the Builder to use when building the Kind cluster.

func (*Builder) WithName ¶ added in v0.1.0

func (b *Builder) WithName(name string) *Builder

WithName indicates a custom name to use for the cluster.

Source Files ¶

View all Source files

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