kongstate

type ACLGroup ¶

type ACLGroup struct {
	kong.ACLGroup
}

ACLGroup represents an ACL associated with a consumer. Due to ACL implementation in Kong being similar to credentials, ACLs are treated as credentials, too.

func NewACLGroup(config interface{}) (*ACLGroup, error)

type BasicAuth ¶

type BasicAuth struct {
	kong.BasicAuth
}

BasicAuth represents a basic authentication credential.

func NewBasicAuth(config interface{}) (*BasicAuth, error)

func (c *BasicAuth) SanitizedCopy() *BasicAuth

type Certificate ¶

type Certificate struct {
	kong.Certificate
}

Certificate represents the certificate object in Kong.

func (c *Certificate) SanitizedCopy() *Certificate

type Consumer ¶

type Consumer struct {
	kong.Consumer
	Plugins    []kong.Plugin
	KeyAuths   []*KeyAuth
	HMACAuths  []*HMACAuth
	JWTAuths   []*JWTAuth
	BasicAuths []*BasicAuth
	ACLGroups  []*ACLGroup

	Oauth2Creds []*Oauth2Credential
	MTLSAuths   []*MTLSAuth

	K8sKongConsumer configurationv1.KongConsumer
}

Consumer holds a Kong consumer and its plugins and credentials.

func (c *Consumer) SanitizedCopy() *Consumer

func (c *Consumer) SetCredential(credType string, credConfig interface{}) error

type HMACAuth ¶

type HMACAuth struct {
	kong.HMACAuth
}

HMACAuth represents a HMAC credential.

func NewHMACAuth(config interface{}) (*HMACAuth, error)

func (c *HMACAuth) SanitizedCopy() *HMACAuth

type JWTAuth ¶

type JWTAuth struct {
	kong.JWTAuth
}

JWTAuth represents a JWT credential.

func NewJWTAuth(config interface{}) (*JWTAuth, error)

func (c *JWTAuth) SanitizedCopy() *JWTAuth

type KeyAuth ¶

type KeyAuth struct {
	kong.KeyAuth
}

KeyAuth represents a key-auth credential.

func NewKeyAuth(config interface{}) (*KeyAuth, error)

func (c *KeyAuth) SanitizedCopy() *KeyAuth

type KongState ¶

type KongState struct {
	Services       []Service
	Upstreams      []Upstream
	Certificates   []Certificate
	CACertificates []kong.CACertificate
	Plugins        []Plugin
	Consumers      []Consumer
	Version        semver.Version
}

KongState holds the configuration that should be applied to Kong.

func (ks *KongState) FillConsumersAndCredentials(log logrus.FieldLogger, s store.Storer)

func (ks *KongState) FillOverrides(log logrus.FieldLogger, s store.Storer)

func (ks *KongState) FillPlugins(log logrus.FieldLogger, s store.Storer)

func (ks *KongState) SanitizedCopy() *KongState

type MTLSAuth ¶

type MTLSAuth struct {
	kong.MTLSAuth
}

MTLSAuth represents an MTLS auth credential.

func NewMTLSAuth(config interface{}) (*MTLSAuth, error)

type Oauth2Credential ¶

type Oauth2Credential struct {
	kong.Oauth2Credential
}

Oauth2Credential represents an OAuth2 client configuration including credentials.

func NewOauth2Credential(config interface{}) (*Oauth2Credential, error)

func (c *Oauth2Credential) SanitizedCopy() *Oauth2Credential

type Plugin ¶

type Plugin struct {
	kong.Plugin
}

Plugin represetns a plugin Object in Kong.

type PortDef ¶

type PortDef struct {
	Mode PortMode

	// Name is the port name as stated in the Kubernetes service. Must be set iff Mode == PortModeName.
	Name string

	// Number is the port number. Must be set iff PortMode == PortModeNumber.
	Number int32
}

func (p *PortDef) CanonicalString() string

type PortMode ¶

type PortMode int

const (
	// PortModeImplicit means that the Ingress does not specify the Kubernetes Service port, and that KIC should expect
	// the Service to have only one port defined.
	PortModeImplicit PortMode = iota
	// PortModeNumber means that the Ingress specifies the Service port by raw port number.
	PortModeByNumber PortMode = iota
	// PortModeNumber means that the Ingress specifies the Service port by its name field.
	PortModeByName PortMode = iota
)

type Route ¶

type Route struct {
	kong.Route

	Ingress util.K8sObjectInfo
	Plugins []kong.Plugin
}

Route represents a Kong Route and holds a reference to the Ingress rule.

type SecretGetter ¶

type SecretGetter interface {
	GetSecret(namespace, name string) (*corev1.Secret, error)
}

type Service ¶

type Service struct {
	kong.Service
	Namespace string
	Routes    []Route
	Plugins   []kong.Plugin

	Backends    []ServiceBackend
	K8sServices map[string]*corev1.Service
	Parent      client.Object
}

Service represents a service in Kong and holds routes associated with the service and other k8s metadata.

type ServiceBackend ¶

type ServiceBackend struct {
	Name      string
	Namespace string
	PortDef   PortDef
	Weight    *int32
}

type ServiceBackends ¶ added in v2.4.0

type ServiceBackends []ServiceBackend

type Services ¶ added in v2.4.0

type Services []*Service

Services is a list of kongstate.Service objects with sorting enabled based on a lexographical comparison of the underlying kong.Service names which are always expected to be unique.

func (s Services) Len() int

func (s Services) Less(i, j int) bool

func (s Services) Swap(i, j int)

type Target ¶

type Target struct {
	kong.Target
}

Target is a wrapper around Target object in Kong.

type Upstream ¶

type Upstream struct {
	kong.Upstream
	Targets []Target
	// Service this upstream is asosciated with.
	Service Service
}

Upstream is a wrapper around Upstream object in Kong.