ingressnginx

README

Ingress Nginx Provider

The project supports translating ingress-nginx specific annotations.

Current supported annotations:

• nginx.ingress.kubernetes.io/canary: If set to true will enable weighting backends.
• nginx.ingress.kubernetes.io/canary-by-header: If specified, the value of this annotation is the header name that will be added as a HTTPHeaderMatch for the routes
• generated from this Ingress. If not specified, no HTTPHeaderMatch will be generated.
• nginx.ingress.kubernetes.io/canary-by-header-value: If specified, the value of this annotation is the header value to perform an HeaderMatchExact match on in the generated HTTPHeaderMatch.
• nginx.ingress.kubernetes.io/canary-by-header-pattern: If specified, this is the pattern to match against for the HTTPHeaderMatch, which will be of type HeaderMatchRegularExpression.
• nginx.ingress.kubernetes.io/canary-weight: If specified and non-zero, this value will be applied as the weight of the backends for the routes generated from this Ingress resource. nginx.ingress.kubernetes.io/canary-weight-total

If you are reliant on any annotations not listed above, please open an issue. In the meantime you'll need to manually find a Gateway API equivalent.

Documentation

Index

• Constants
• func NewProvider(conf *i2gw.ProviderConf) i2gw.Provider
• type OrderedIngressMap
  • func (oim *OrderedIngressMap) FromMap(ingresses map[types.NamespacedName]*networkingv1.Ingress)
  • func (oim *OrderedIngressMap) List() []networkingv1.Ingress
• type Provider
  • func (p *Provider) ReadResourcesFromCluster(ctx context.Context) error
  • func (p *Provider) ReadResourcesFromFile(_ context.Context, filename string) error
  • func (p *Provider) ToGatewayResources(ir intermediate.IR) (i2gw.GatewayResources, field.ErrorList)
  • func (p *Provider) ToIR() (intermediate.IR, field.ErrorList)

Constants

const Name = "ingress-nginx"

The Name of the provider.

const NginxIngressClass = "nginx"

Functions

func NewProvider

func NewProvider(conf *i2gw.ProviderConf) i2gw.Provider

NewProvider constructs and returns the ingress-nginx implementation of i2gw.Provider.

Types

type OrderedIngressMap

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

func (*OrderedIngressMap) FromMap

func (oim *OrderedIngressMap) FromMap(ingresses map[types.NamespacedName]*networkingv1.Ingress)

func (*OrderedIngressMap) List

func (oim *OrderedIngressMap) List() []networkingv1.Ingress

type Provider

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

Provider implements the i2gw.Provider interface.

func (*Provider) ReadResourcesFromCluster

func (p *Provider) ReadResourcesFromCluster(ctx context.Context) error

func (*Provider) ReadResourcesFromFile

func (p *Provider) ReadResourcesFromFile(_ context.Context, filename string) error

func (*Provider) ToGatewayResources

func (p *Provider) ToGatewayResources(ir intermediate.IR) (i2gw.GatewayResources, field.ErrorList)

func (*Provider) ToIR

func (p *Provider) ToIR() (intermediate.IR, field.ErrorList)

ToIR converts stored Ingress-Nginx API entities to intermediate.IR including the ingress-nginx specific features.