ingress

Documentation

Overview

Package ingress contains all the logic for Cilium Ingress Controller For every Ingress object, the controller will check if spec.ingressClassName is cilium, then perform the respective operations

• Create one Load Balancer service, the external IP/FQDN is available will bubble up to Ingress status once ready.
• Create CiliumEnvoyConfig with all routing details.
• Create dummy Endpoint for above LB service

All above child resources are having respective ownerReferences for proper cleanup.

There is a small secret sync component, which will watch all tls ingress secrets and sync them to another give namespace. This is to limit the permission during runtime in all nodes.

Index

• Constants
• Variables
• type IngressController
  • func NewIngressController(options ...Option) (*IngressController, error)
  • func (ic *IngressController) Run()
• type Option
  • func WithHTTPSEnforced(enforcedHTTPS bool) Option
  • func WithLBAnnotationPrefixes(lbAnnotationPrefixes []string) Option
  • func WithMaxRetries(maxRetries int) Option
  • func WithSecretsNamespace(secretsNamespace string) Option
  • func WithSecretsSyncEnabled(enabledSecretsSync bool) Option
• type Options
• type SortableRoute
  • func (s SortableRoute) Len() int
  • func (s SortableRoute) Less(i, j int) bool
  • func (s SortableRoute) Swap(i, j int)

Constants

const Subsys = "ingress-controller"

Variables

var DefaultIngressOptions = Options{
	MaxRetries:           10,
	EnforcedHTTPS:        true,
	EnabledSecretsSync:   true,
	LBAnnotationPrefixes: []string{},
}

DefaultIngressOptions specifies default values for cilium ingress controller.

Types

type IngressController

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

IngressController is a simple pattern that allows to perform the following tasks:

• Watch cilium Ingress object
• Manage related child resources for this Ingress
• Service
• Endpoint
• CiliumEnvoyConfig
• Manage synced TLS secrets in given namespace
• TLS secrets

func NewIngressController

func NewIngressController(options ...Option) (*IngressController, error)

NewIngressController returns a controller for ingress objects having ingressClassName as cilium

func (*IngressController) Run

func (ic *IngressController) Run()

Run kicks off the controlled loop

type Option

type Option func(o *Options) error

Option customizes the configuration of cilium ingress controller

func WithHTTPSEnforced

func WithHTTPSEnforced(enforcedHTTPS bool) Option

WithHTTPSEnforced specifies if https enforcement should be done or not

func WithLBAnnotationPrefixes

func WithLBAnnotationPrefixes(lbAnnotationPrefixes []string) Option

WithLBAnnotationPrefixes configures LB annotations to be used for LB service

func WithMaxRetries

func WithMaxRetries(maxRetries int) Option

WithMaxRetries sets the maximum number of retries while processing events

func WithSecretsNamespace

func WithSecretsNamespace(secretsNamespace string) Option

WithSecretsNamespace configures destination namespace for syncing all TLS secrets across namespaces.

func WithSecretsSyncEnabled

func WithSecretsSyncEnabled(enabledSecretsSync bool) Option

WithSecretsSyncEnabled specifies if secrets syncs process should be done or not

type Options

type Options struct {
	MaxRetries           int
	EnforcedHTTPS        bool
	EnabledSecretsSync   bool
	SecretsNamespace     string
	LBAnnotationPrefixes []string
}

Options stores all the configurations values for cilium ingress controller.

type SortableRoute

type SortableRoute []*envoy_config_route_v3.Route

SortableRoute is a slice of envoy Route, which can be sorted based on matching order as per Ingress requirement.

- Exact Match must have the highest priority - If multiple prefix matches are satisfied, the longest path is having higher priority

As Envoy route matching logic is done sequentially, we need to enforce such sorting order.

func (SortableRoute) Len

func (s SortableRoute) Len() int

func (SortableRoute) Less

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

func (SortableRoute) Swap

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