model

Documentation

Overview

Package model contains a data model for translations from upstream Kubernetes resources to Cilium Kubernetes resources.

Initially, used for Ingress to CiliumEnvoyConfig translation to enable shared load balancing, but will be used for other things in the future (such as Gateway API support).

Index

• func AddressOf[T any](v T) *T
• func ComputeHosts(routeHostnames []string, listenerHostname *string) []string
• type Backend
• type BackendPort
  • func (be *BackendPort) GetPort() string
• type DirectResponse
• type FullyQualifiedResource
  • func AddSource(sourceList []FullyQualifiedResource, source FullyQualifiedResource) []FullyQualifiedResource
• type HTTPHeaderFilter
• type HTTPListener
• type HTTPRequestRedirectFilter
• type HTTPRoute
  • func (r *HTTPRoute) GetMatchKey() string
• type Header
• type KeyValueMatch
  • func (kv KeyValueMatch) String() string
• type Model
• type Service
• type StringMatch
  • func (sm StringMatch) String() string
• type TLSSecret

Functions

func AddressOf

func AddressOf[T any](v T) *T

func ComputeHosts

func ComputeHosts(routeHostnames []string, listenerHostname *string) []string

ComputeHosts returns a list of the intersecting hostnames between the route and the listener. The below function is inspired from https://github.com/envoyproxy/gateway/blob/main/internal/gatewayapi/helpers.go. Special thanks to Envoy team.

Types

type Backend

type Backend struct {
	// Name of the Service.
	Name string `json:"name,omitempty"`
	// Namespace of the Service.
	Namespace string `json:"namespace,omitempty"`
	// Port contains the details of the port on the Service to connect to
	// If unset, the same port as the top-level Listener will be used.
	Port *BackendPort `json:"port,omitempty"`

	// Weight specifies the percentage of traffic to send to this backend.
	// This is computed as weight/(sum of all weights in backends) * 100.
	Weight *int32 `json:"weight,omitempty"`
}

Backend holds a Kubernetes Service that points to a backend for traffic.

type BackendPort

type BackendPort struct {
	// Port holds the numeric port to connect to.
	Port uint32 `json:"port,omitempty"`
	// Name holds a string which will be used to connect to the port with a
	// matching spec.ports[].name in the target Service.
	Name string `json:"name,omitempty"`
}

BackendPort holds the details of what port on the Service to connect to. Only one of Port or Name can be set.

func (*BackendPort) GetPort

func (be *BackendPort) GetPort() string

GetPort return the string representation of the port (either the port number or the port name)

type DirectResponse

type DirectResponse struct {
	StatusCode int    `json:"status_code,omitempty"`
	Body       string `json:"payload,omitempty"`
}

DirectResponse holds configuration for a direct response.

type FullyQualifiedResource

type FullyQualifiedResource struct {
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	Group     string `json:"group,omitempty"`
	Version   string `json:"version,omitempty"`
	Kind      string `json:"kind,omitempty"`
	UID       string `json:"uuid,omitempty"`
}

FullyQualifiedResource stores the full details of a Kubernetes resource, including the Group, Version, and Kind. Namespace must be set to the empty string for cluster-scoped resources.

func AddSource

func AddSource(sourceList []FullyQualifiedResource, source FullyQualifiedResource) []FullyQualifiedResource

type HTTPHeaderFilter

type HTTPHeaderFilter struct {
	// HeadersToAdd is a list of headers to add to the request.
	// Existing headers with the same name will be appended to.
	HeadersToAdd []Header `json:"headers_to_add,omitempty"`
	// HeadersToSet is a list of headers to set in the request.
	// Existing headers will be overwritten.
	HeadersToSet []Header `json:"headers_to_set,omitempty"`
	// HeadersToRemove is a list of headers to remove from the request.
	HeadersToRemove []string `json:"headers_to_remove,omitempty"`
}

HTTPHeaderFilter holds configuration for a request header filter.

type HTTPListener

type HTTPListener struct {
	// Name of the HTTPListener
	Name string `json:"name,omitempty"`
	// Sources is a slice of fully qualified resources this HTTPListener is sourced
	// from.
	Sources []FullyQualifiedResource `json:"sources,omitempty"`
	// IPAddress that the listener should listen on.
	// The string must be parseable as an IP address.
	Address string `json:"address,omitempty"`
	// Port on which the service can be expected to be accessed by clients.
	Port uint32 `json:"port,omitempty"`
	// Hostname that the listener should match.
	// Wildcards are supported in prefix or suffix forms, or the special wildcard `*`.
	// An empty list means that the Listener should match all hostnames.
	Hostname string `json:"hostname,omitempty"`
	// TLS Certificate information. If omitted, then the listener is a cleartext HTTP listener.
	TLS []TLSSecret `json:"tls,omitempty"`
	// Routes associated with HTTP traffic to the service.
	// An empty list means that traffic will not be routed.
	Routes []HTTPRoute `json:"routes,omitempty"`
	// Service configuration
	Service *Service `json:"service,omitempty"`
}

HTTPListener holds configuration for any listener that terminates and proxies HTTP including HTTP and HTTPS. Each holds the configuration info for one distinct HTTP listener, by

• Hostname
• TLS
• Address
• Port

type HTTPRequestRedirectFilter

type HTTPRequestRedirectFilter struct {
	// Scheme is the scheme to be used in the value of the `Location` header in
	// the response. When empty, the scheme of the request is used.
	Scheme *string `json:"scheme,omitempty"`

	// Hostname is the hostname to be used in the value of the `Location`
	// header in the response.
	// When empty, the hostname of the request is used.
	Hostname *string `json:"hostname,omitempty"`

	// Path defines parameters used to modify the path of the incoming request.
	// The modified path is then used to construct the `Location` header. When
	// empty, the request path is used as-is.
	Path *StringMatch `json:"path,omitempty"`

	// Port is the port to be used in the value of the `Location`
	// header in the response.
	// When empty, port (if specified) of the request is used.
	Port *int32 `json:"port,omitempty"`

	// StatusCode is the HTTP status code to be used in response.
	//
	// Note that values may be added to this enum, implementations
	// must ensure that unknown values will not cause a crash.
	StatusCode *int `json:"statusCode,omitempty"`
}

HTTPRequestRedirectFilter holds configuration for a request redirect.

type HTTPRoute

type HTTPRoute struct {
	Name string `json:"name,omitempty"`
	// Hostnames that the route should match
	Hostnames []string `json:"hostnames,omitempty"`
	// PathMatch specifies that the HTTPRoute should match a path.
	PathMatch StringMatch `json:"path_match,omitempty"`
	// HeadersMatch specifies that the HTTPRoute should match a set of headers.
	HeadersMatch []KeyValueMatch `json:"headers_match,omitempty"`
	// QueryParamsMatch specifies that the HTTPRoute should match a set of query parameters.
	QueryParamsMatch []KeyValueMatch `json:"query_params_match,omitempty"`
	Method           *string         `json:"method,omitempty"`
	// Backend is the backend handling the requests
	Backends []Backend `json:"backends,omitempty"`
	// DirectResponse instructs the proxy to respond directly to the client.
	DirectResponse *DirectResponse `json:"direct_response,omitempty"`

	// RequestHeaderFilter can be used to add or remove an HTTP
	//header from an HTTP request before it is sent to the upstream target.
	RequestHeaderFilter *HTTPHeaderFilter `json:"request_header_filter,omitempty"`

	// ResponseHeaderModifier can be used to add or remove an HTTP
	//header from an HTTP response before it is sent to the client.
	ResponseHeaderModifier *HTTPHeaderFilter `json:"response_header_modifier,omitempty"`

	// RequestRedirect defines a schema for a filter that responds to the
	// request with an HTTP redirection.
	RequestRedirect *HTTPRequestRedirectFilter `json:"requestRedirect,omitempty"`
}

HTTPRoute holds all the details needed to route HTTP traffic to a backend.

func (*HTTPRoute) GetMatchKey

func (r *HTTPRoute) GetMatchKey() string

GetMatchKey returns the key to be used for matching the backend.

type Header

type Header struct {
	Name  string
	Value string
}

Header is a key-value pair.

type KeyValueMatch

type KeyValueMatch struct {
	Key   string      `json:"key,omitempty"`
	Match StringMatch `json:"match,omitempty"`
}

func (KeyValueMatch) String

func (kv KeyValueMatch) String() string

type Model

type Model struct {
	HTTP []HTTPListener `json:"http,omitempty"`
}

Model holds an abstracted data model representing the translation of various types of Kubernetes config to Cilium config.

type Service

type Service struct {
	// Type is the type of service that is being used for Listener (e.g. Load Balancer or Node port)
	// Defaults to Load Balancer type
	Type string `json:"serviceType,omitempty"`
	// InsecureNodePort is the back-end port of the service that is being used for HTTP Listener
	// Applicable only if Type is Node NodePort
	InsecureNodePort *uint32 `json:"insecureNodePort,omitempty"`
	// SecureNodePort is the back-end port of the service that is being used for HTTPS Listener
	// Applicable only if Type is Node NodePort
	SecureNodePort *uint32 `json:"secureNodePort,omitempty"`
}

Service holds the configuration for desired Service details

type StringMatch

type StringMatch struct {
	Prefix string `json:"prefix,omitempty"`
	Exact  string `json:"exact,omitempty"`
	Regex  string `json:"regex,omitempty"`
}

StringMatch describes various types of string matching. Only one field may be set. If no fields are set, all paths should match (no path match criteria should be generated for Envoy.)

func (StringMatch) String

func (sm StringMatch) String() string

type TLSSecret

type TLSSecret struct {
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
}

TLSSecret holds a reference to a secret containing a TLS keypair.