2018-05-03 10:41:12 +00:00
# Ingress examples
2021-11-09 15:43:49 +00:00
This directory contains a catalog of examples on how to run, configure and scale Ingress.
2018-05-03 10:41:12 +00:00
Please review the [prerequisites ](PREREQUISITES.md ) before trying them.
2021-11-09 15:43:49 +00:00
The examples on these pages include the `spec.ingressClassName` field which replaces the deprecated `kubernetes.io/ingress.class: nginx` annotation. Users of ingress-nginx < 1.0.0 ( Helm chart < 4 . 0 . 0 ) should use the [legacy documentation ](https://github.com/kubernetes/ingress-nginx/tree/legacy/docs/examples ).
For more information, check out the [Migration to apiVersion networking.k8s.io/v1 ](../#faq-migration-to-apiversion-networkingk8siov1 ) guide.
2018-05-03 10:41:12 +00:00
Category | Name | Description | Complexity Level
---------| ---- | ----------- | ----------------
Apps | [Docker Registry ](docker-registry/README.md ) | TODO | TODO
Auth | [Basic authentication ](auth/basic/README.md ) | password protect your website | Intermediate
Auth | [Client certificate authentication ](auth/client-certs/README.md ) | secure your website with client certificate authentication | Intermediate
Auth | [External authentication plugin ](auth/external-auth/README.md ) | defer to an external authentication service | Intermediate
Auth | [OAuth external auth ](auth/oauth-external-auth/README.md ) | TODO | TODO
Customization | [Configuration snippets ](customization/configuration-snippets/README.md ) | customize nginx location configuration using annotations | Advanced
Customization | [Custom configuration ](customization/custom-configuration/README.md ) | TODO | TODO
Customization | [Custom DH parameters for perfect forward secrecy ](customization/ssl-dh-param/README.md ) | TODO | TODO
2018-06-12 22:03:48 +00:00
Customization | [Custom errors ](customization/custom-errors/README.md ) | serve custom error pages from the default backend | Intermediate
2021-11-09 15:43:49 +00:00
Customization | [Custom headers ](customization/custom-headers/README.md ) | set custom headers before sending traffic to backends | Advanced
2018-05-03 10:41:12 +00:00
Customization | [External authentication with response header propagation ](customization/external-auth-headers/README.md ) | TODO | TODO
Customization | [Sysctl tuning ](customization/sysctl/README.md ) | TODO | TODO
Features | [Rewrite ](rewrite/README.md ) | TODO | TODO
Features | [Session stickiness ](affinity/cookie/README.md ) | route requests consistently to the same endpoint | Advanced
2024-09-06 14:59:43 +00:00
Features | [Canary Deployments ](canary/README.md ) | weighted canary routing to a separate deployment | Intermediate
2018-05-03 10:41:12 +00:00
Scaling | [Static IP ](static-ip/README.md ) | a single ingress gets a single static IP | Intermediate
TLS | [Multi TLS certificate termination ](multi-tls/README.md ) | TODO | TODO
TLS | [TLS termination ](tls-termination/README.md ) | TODO | TODO
