parser

Documentation

Index

• Constants
• Variables
• func GenerateKongRouteFromTranslation(httproute *gatewayv1beta1.HTTPRoute, ...) ([]kongstate.Route, error)
• type FeatureFlags
  • func NewFeatureFlags(logger logrus.FieldLogger, featureGates featuregates.FeatureGates, ...) FeatureFlags
• type KongConfigBuildingResult
• type KongServicesCache
  • func IngressesV1ToKongServices(featureFlags FeatureFlags, ingresses []*netv1.Ingress, ...) KongServicesCache
• type LicenseGetter
• type ObjectsCollector
  • func NewObjectsCollector() *ObjectsCollector
  • func (p *ObjectsCollector) Add(obj client.Object)
  • func (p *ObjectsCollector) Pop() []client.Object
• type Parser
  • func NewParser(logger logrus.FieldLogger, storer store.Storer, featureFlags FeatureFlags, ...) (*Parser, error)
  • func (p *Parser) BuildKongConfig() KongConfigBuildingResult
  • func (p *Parser) InjectLicenseGetter(licenseGetter LicenseGetter)
• type SNIs
  • func (s SNIs) Hosts() []string
  • func (s SNIs) Parents() []client.Object
• type SecretNameToSNIs
  • func (m SecretNameToSNIs) Hosts(secretKey string) []string
  • func (m SecretNameToSNIs) Parents(secretKey string) []client.Object

Constants

const (
	// DefaultServiceTimeout indicates the amount of time (by default) for
	// connections, reads and writes to a service over a network should
	// be given before timing out by default.
	DefaultServiceTimeout = 60000

	// DefaultRetries indicates the number of times a connection should be
	// retried by default.
	DefaultRetries = 5

	// DefaultHTTPPort is the network port that should be assumed by default
	// for HTTP traffic to services.
	DefaultHTTPPort = 80
)

const (
	KindGateway = gatewayv1beta1.Kind("Gateway")
)

Variables

var LegacyRegexPathExpression = regexp.MustCompile(`^[a-zA-Z0-9\.\-_~/%]*$`)

LegacyRegexPathExpression is the regular expression used by Kong <3.0 to determine if a path is not a regex.

Functions

func GenerateKongRouteFromTranslation

func GenerateKongRouteFromTranslation(
	httproute *gatewayv1beta1.HTTPRoute,
	translation translators.KongRouteTranslation,
	addRegexPrefix bool,
	expressionRoutes bool,
	kongVersion semver.Version,
) ([]kongstate.Route, error)

GenerateKongRouteFromTranslation generates Kong routes from HTTPRoute pointing to a specific backend. It is used for both traditional and expression based routes.

Types

type FeatureFlags

type FeatureFlags struct {
	// ReportConfiguredKubernetesObjects turns on object reporting for this parser:
	// each subsequent call to BuildKongConfig() will track the Kubernetes objects which
	// were successfully parsed.
	ReportConfiguredKubernetesObjects bool

	// CombinedServiceRoutes changes the translation logic from the legacy
	// mode which would create a kong.Route object per each individual path on
	// an Ingress object to a mode that can combine routes for paths where the
	// service name, host and port match for those paths.
	CombinedServiceRoutes bool

	// RegexPathPrefix enables adding the Kong 3.x+ regex path prefix on regex paths generated by the controller
	// (to satisfy the Ingress Prefix and Exact path types) or indicated by a resource (e.g. when an HTTPRoute uses a
	// RegularExpression Match). It does _not_ enable heuristic regex path detection for Ingress ImplementationSpecific
	// paths, which require an IngressClass setting.
	RegexPathPrefix bool

	// ExpressionRoutes indicates whether to translate Kubernetes objects to expression based Kong Routes.
	ExpressionRoutes bool

	// CombinedServices enables parser to create a single Kong Service when a Kubernetes Service is referenced
	// by multiple Ingresses. This is effective only when EnableCombinedServiceRoutes is enabled.
	CombinedServices bool

	// FillIDs enables the parser to fill in the IDs fields of Kong entities - Services, Routes, and Consumers - based
	// on their names. It ensures that IDs remain stable across restarts of the controller.
	FillIDs bool

	// RewriteURIs enables the parser to translate the konghq.com/rewrite annotation to the proper set of Kong plugins.
	RewriteURIs bool
}

FeatureFlags are used to control the behavior of the parser.

func NewFeatureFlags

func NewFeatureFlags(
	logger logrus.FieldLogger,
	featureGates featuregates.FeatureGates,
	kongVersion semver.Version,
	routerFlavor string,
	updateStatusFlag bool,
) FeatureFlags

type KongConfigBuildingResult

type KongConfigBuildingResult struct {
	// KongState is the Kong configuration used to configure the Gateway(s).
	KongState *kongstate.KongState

	// TranslationFailures is a list of resource failures that occurred during parsing.
	// They should be used to provide users with feedback on Kubernetes objects validity.
	TranslationFailures []failures.ResourceFailure

	// ConfiguredKubernetesObjects is a list of Kubernetes objects that were successfully parsed.
	ConfiguredKubernetesObjects []client.Object
}

KongConfigBuildingResult is a result of Parser.BuildKongConfig method.

type KongServicesCache

type KongServicesCache map[string]kongstate.Service

KongServicesCache is a cache of Kong Services indexed by their name.

func IngressesV1ToKongServices

func IngressesV1ToKongServices(
	featureFlags FeatureFlags,
	ingresses []*netv1.Ingress,
	icp kongv1alpha1.IngressClassParametersSpec,
	parsedObjectsCollector *ObjectsCollector,
	failuresCollector *failures.ResourceFailuresCollector,
) KongServicesCache

IngressesV1ToKongServices translates IngressV1 object into Kong Service, returns them indexed by name. Argument parsedObjectsCollector is used to register all successfully parsed objects. In case of a failure, the object is registered in failuresCollector.

type LicenseGetter

type LicenseGetter interface {
	// GetLicense returns an optional license.
	GetLicense() mo.Option[kong.License]
}

LicenseGetter is an interface for getting the Kong Enterprise license.

type ObjectsCollector

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

ObjectsCollector collects objects for later use. Its methods are safe to call with a nil receiver.

func NewObjectsCollector

func NewObjectsCollector() *ObjectsCollector

func (*ObjectsCollector) Add

func (p *ObjectsCollector) Add(obj client.Object)

Add adds an object to the collector. Noop if the receiver is nil.

func (*ObjectsCollector) Pop

func (p *ObjectsCollector) Pop() []client.Object

Pop returns the objects collected so far and resets the collector. Returns nil if the receiver is nil.

type Parser

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

Parser parses Kubernetes objects and configurations into their equivalent Kong objects and configurations, producing a complete state configuration for the Kong Admin API.

func NewParser

func NewParser(
	logger logrus.FieldLogger,
	storer store.Storer,
	featureFlags FeatureFlags,
	kongVersion semver.Version,
) (*Parser, error)

NewParser produces a new Parser object provided a logging mechanism and a Kubernetes object store.

func (*Parser) BuildKongConfig

func (p *Parser) BuildKongConfig() KongConfigBuildingResult

BuildKongConfig creates a Kong configuration from Ingress and Custom resources defined in Kubernetes.

func (*Parser) InjectLicenseGetter

func (p *Parser) InjectLicenseGetter(licenseGetter LicenseGetter)

InjectLicenseGetter sets a license getter to be used by the parser.

type SNIs

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

func (SNIs) Hosts

func (s SNIs) Hosts() []string

func (SNIs) Parents

func (s SNIs) Parents() []client.Object

type SecretNameToSNIs

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

func (SecretNameToSNIs) Hosts

func (m SecretNameToSNIs) Hosts(secretKey string) []string

func (SecretNameToSNIs) Parents

func (m SecretNameToSNIs) Parents(secretKey string) []client.Object