ingressnginx

package

v0.2.0 Latest Latest Go to latest Published: Feb 1, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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.

View Source

const Name = "ingress-nginx"

The Name of the provider.

View Source

const NginxIngressClass = "nginx"

This section is empty.

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

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

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

Provider implements the i2gw.Provider interface.

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

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

func (p *Provider) ToGatewayAPI(_ i2gw.InputResources) (i2gw.GatewayResources, field.ErrorList)

ToGatewayAPI converts the received i2gw.InputResources to i2gw.GatewayResources including the ingress-nginx specific features.