README
¶
knative/networking
This repository contains the Knative Ingress and Certificate CRDs, as well as their conformance tests. These are our extension points to plugin different Ingress plugins (Ambassador, Contour, Gloo, Istio, Kong and Kourier), as well as different ExternalDomainTLS plugins (CertManager and Knative's own HTTP01 challenge solver).
Knative Ingress aka KIngress
The Knative Ingress CRD is based on the Kubernetes Ingress CRD, with the following additions:
- Traffic splitting
- Header modification applied to requests based on the traffic split they are assigned to.
- Host header rewrite
- Traffic redirection predicates based on a regexp based condition on headers.
In addition to these, we previously added Timeout and Retry settings but no longer used them and may deprecate these parts in future versions.
See https://knative.dev/docs/install/yaml-install/serving/install-serving-with-yaml/#install-a-networking-layer for a list of the current supported KIngress implementations.
Check out:
- pkg/apis/networking/v1alpha1/ingress_types.go for more information about the KIngress API spec.
- pkg/apis/networking/v1alpha1/ingress_validation.go for more information about the validation logic for KIngress API spec.
- test/conformance/ingress/README.md for the conformance tests and how to run them.
See also:
- http://github.com/knative-extensions/net-contour for the Contour-based implementation of KIngress.
- http://github.com/knative-extensions/net-kourier for a dependency-free implementation of KIngress based on Envoy proxy.
- http://github.com/knative-extensions/net-istio For the Istio-based implementation of KIngress.
Knative Certificate aka KCert
Knative Certificate CRD is a Knative abstraction for various SSL certificate provisioning solutions (such as cert-manager or self-signed SSL certificate).
Check out:
- pkg/apis/networking/v1alpha1/certificate_types.go for more information about the Certificate API spec.
- pkg/apis/networking/v1alpha1/certificate_validation.go for more information about the validation logic for Certificate API spec.
Contributing
If you would like to contribute to Knative, take a look at CLOTRIBUTOR for a list of help wanted issues across the project.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config exists to make the config directory importable.
|
Package config exists to make the config directory importable. |
|
apis/config
Package config holds the typed objects that define the schemas for ConfigMap objects that pertain to our API objects.
|
Package config holds the typed objects that define the schemas for ConfigMap objects that pertain to our API objects. |
|
apis/networking/v1alpha1
+k8s:deepcopy-gen=package +groupName=networking.internal.knative.dev
|
+k8s:deepcopy-gen=package +groupName=networking.internal.knative.dev |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/networking/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/networking/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
config
+k8s:deepcopy-gen=package Package network holds the typed objects that define the schemas for configuring the knative/serving networking layer.
|
+k8s:deepcopy-gen=package Package network holds the typed objects that define the schemas for configuring the knative/serving networking layer. |
|
ingress
Package ingress holds utilities related to the implementation of ingress controllers.
|
Package ingress holds utilities related to the implementation of ingress controllers. |
|
prober
Package prober contains functionality for implementing probing in knative serving.
|
Package prober contains functionality for implementing probing in knative serving. |