Help us shape the future of Go! Take the 2026 Go Developer Survey

registry

package
v0.31.2 Latest Latest
Warning

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

Go to latest
Published: Jul 6, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

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

	// Namespace is the namespace that the Addon compontents
	// will be deployed under when deployment finishes
	Namespace = "registry"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Addon

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

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

func New

func New() *Addon

New produces a new clusters.Addon for Kong but uses a very opionated set of default configurations (see the defaults() function for more details). If you need to customize your Kong deployment, use the kong.Builder instead.

func (*Addon) CertificatePEM

func (a *Addon) CertificatePEM() []byte

Certificate returns the PEM encoded x509 certificate used for TLS communications with the registry server.

func (*Addon) ClusterIP

func (a *Addon) ClusterIP() string

ClusterIP indicates the cluster network address of the registry server

func (*Addon) Delete

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

func (*Addon) Dependencies

func (a *Addon) Dependencies(_ context.Context, cluster 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) LoadBalancerAddress

func (a *Addon) LoadBalancerAddress() string

LoadBalancerAddress indicates the publish network address of the registry server this will return empty if the addon was not configured to use a LoadBalancer type Service (e.g. builder.WithServiceTypeLoadBalancer()).

func (*Addon) Name

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

func (*Addon) Namespace

func (a *Addon) Namespace() string

Namespace indicates the namespace where the Registry 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() *semver.Version

Version indicates the Registry version for this addon.

type Builder

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

Builder is a configuration tool to generate Registry cluster addons.

func NewBuilder

func NewBuilder() *Builder

NewBuilder provides a new Builder object for configuring Registry 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) WithServiceTypeLoadBalancer

func (b *Builder) WithServiceTypeLoadBalancer() *Builder

WithServiceTypeLoadBalancer configures the Registry's Kubernetes service to be of type LoadBalancer to support access from outside the cluster network.

func (*Builder) WithVersion

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

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

Jump to

Keyboard shortcuts

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