kuma

package

v0.47.0 Latest Latest Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 16 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/kong/kubernetes-testing-framework

Links

Open Source Insights

Documentation ¶

Index ¶

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

Constants ¶

View Source

const (
	// AddonName is the unique name of the Kong cluster.Addon
	AddonName clusters.AddonName = "kuma"

	// Namespace is the namespace that the Addon compontents
	// will be deployed under when deployment finishes
	Namespace = "kuma-system"

	// KumaHelmRepo is the Kuma Helm repo URL
	KumaHelmRepo = "https://kumahq.github.io/charts"

	// DefaultReleaseName is the default Helm release name
	DefaultReleaseName = "ktfkuma"
)

Variables ¶

This section is empty.

Functions ¶

func EnableMeshForNamespace ¶

func EnableMeshForNamespace(ctx context.Context, cluster clusters.Cluster, name string) error

EnableMeshForNamespace will add the "kuma.io/sidecar-injection: enabled" label to the provided namespace, enabling sidecar injections fo all Pods in the namespace

Types ¶

type Addon ¶

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

Addon is a Kuma addon which can be deployed on a clusters.Cluster.

func New ¶

func New() *Addon

New produces a new clusters.Addon for Kuma with MTLS enabled

func (*Addon) Delete ¶

func (a *Addon) Delete(ctx context.Context, cluster clusters.Cluster) error

func (*Addon) Dependencies ¶

func (a *Addon) Dependencies(_ context.Context, _ clusters.Cluster) []clusters.AddonName

func (*Addon) Deploy ¶

func (a *Addon) Deploy(ctx context.Context, cluster clusters.Cluster) error

func (*Addon) DumpDiagnostics ¶ added in v0.17.0

func (a *Addon) DumpDiagnostics(context.Context, clusters.Cluster) (map[string][]byte, error)

func (*Addon) Name ¶

func (a *Addon) Name() clusters.AddonName

func (*Addon) Namespace ¶

func (a *Addon) Namespace() string

Namespace indicates the namespace where the Kuma addon components are to be deployed and managed.

func (*Addon) Ready ¶

func (a *Addon) Ready(ctx context.Context, cluster clusters.Cluster) (waitForObjects []runtime.Object, ready bool, err error)

func (*Addon) Version ¶

func (a *Addon) Version() (v semver.Version, ok bool)

Version returns the version of the Kuma Helm chart deployed by the addon. If the version is not set, the second return value will be false and the latest local chart version will be used.

type Builder ¶

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

Builder is a configuration tool to generate Kuma cluster addons.

func NewBuilder ¶

func NewBuilder() *Builder

NewBuilder provides a new Builder object for configuring Kuma cluster addons.

func (*Builder) Build ¶

func (b *Builder) Build() *Addon

Build generates a new kong cluster.Addon which can be loaded and deployed into a test Environment's cluster.Cluster.

func (*Builder) WithAdditionalValue ¶ added in v0.46.0

func (b *Builder) WithAdditionalValue(name, value string) *Builder

WithAdditionalValue sets a key and value to pass to Helm using --set.

func (*Builder) WithLogger ¶

func (b *Builder) WithLogger(logger *logrus.Logger) *Builder

WithLogger adds a logger that will provide extra information about the build step of the addon at various configured log levels.

func (*Builder) WithMTLS ¶

func (b *Builder) WithMTLS() *Builder

WithMTLS enables the MTLS policy on the default mesh

See: https://kuma.io/docs/dev/policies/mutual-tls/

func (*Builder) WithVersion ¶

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

WithVersion configures the specific version of Kuma which should be deployed.

Source Files ¶

View all Source files

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