2018-04-27 00:09:55 +00:00
2019-03-02 18:14:04 +00:00
<!doctype html>
2018-04-27 00:09:55 +00:00
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "lang:clipboard.copy" content = "Copy to clipboard" >
< meta name = "lang:clipboard.copied" content = "Copied to clipboard" >
< meta name = "lang:search.language" content = "en" >
< meta name = "lang:search.pipeline.stopwords" content = "True" >
< meta name = "lang:search.pipeline.trimmer" content = "True" >
< meta name = "lang:search.result.none" content = "No matching documents" >
< meta name = "lang:search.result.one" content = "1 matching document" >
< meta name = "lang:search.result.other" content = "# matching documents" >
< meta name = "lang:search.tokenizer" content = "[\s\-]+" >
2018-09-13 23:54:10 +00:00
< link rel = "shortcut icon" href = "../../../assets/images/favicon.png" >
2019-03-02 18:14:04 +00:00
< meta name = "generator" content = "mkdocs-1.0.4, mkdocs-material-4.0.2" >
2018-04-27 00:09:55 +00:00
< title > Custom Errors - NGINX Ingress Controller< / title >
2019-03-02 18:14:04 +00:00
< link rel = "stylesheet" href = "../../../assets/stylesheets/application.982221ab.css" >
2018-04-27 00:09:55 +00:00
2019-03-02 18:14:04 +00:00
< link rel = "stylesheet" href = "../../../assets/stylesheets/application-palette.224b79ff.css" >
2018-04-27 00:09:55 +00:00
2018-07-13 23:53:25 +00:00
< meta name = "theme-color" content = "#009688" >
2018-04-27 00:09:55 +00:00
2019-03-02 18:14:04 +00:00
< script src = "../../../assets/javascripts/modernizr.1f0bcf2b.js" > < / script >
2018-04-27 00:09:55 +00:00
2018-09-13 23:54:10 +00:00
< link href = "https://fonts.gstatic.com" rel = "preconnect" crossorigin >
2018-04-27 00:09:55 +00:00
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono" >
< style > body , input { font-family : "Roboto" , "Helvetica Neue" , Helvetica , Arial , sans-serif } code , kbd , pre { font-family : "Roboto Mono" , "Courier New" , Courier , monospace } < / style >
2018-09-13 23:54:10 +00:00
< link rel = "stylesheet" href = "../../../assets/fonts/material-icons.css" >
2018-04-27 00:09:55 +00:00
2018-12-04 15:07:57 +00:00
2018-09-13 23:54:10 +00:00
< link rel = "stylesheet" href = "../../../extra.css" >
2018-04-27 12:02:43 +00:00
2018-04-27 00:09:55 +00:00
2019-03-02 18:14:04 +00:00
< script >
window.ga = window.ga || function() {
(ga.q = ga.q || []).push(arguments)
}
ga.l = +new Date
/* Setup integration and send page view */
ga("create", "UA-118407822-1", "kubernetes.github.io")
ga("set", "anonymizeIp", true)
ga("send", "pageview")
/* Register handler to log search on blur */
document.addEventListener("DOMContentLoaded", () => {
if (document.forms.search) {
var query = document.forms.search.query
query.addEventListener("blur", function() {
if (this.value) {
var path = document.location.pathname;
ga("send", "pageview", path + "?q=" + this.value)
}
})
}
})
< / script >
< script async src = "https://www.google-analytics.com/analytics.js" > < / script >
2018-04-27 00:09:55 +00:00
< / head >
< body dir = "ltr" data-md-color-primary = "teal" data-md-color-accent = "green" >
< svg class = "md-svg" >
< defs >
< svg xmlns = "http://www.w3.org/2000/svg" width = "416" height = "448"
2018-07-13 23:53:25 +00:00
viewBox="0 0 416 448" id="__github">
2018-04-27 00:09:55 +00:00
< path fill = "currentColor" d = "M160 304q0 10-3 . 125 20 . 5t-10 . 75 19-18 . 125
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
99.5z" />
< / svg >
< / defs >
< / svg >
2018-07-13 23:53:25 +00:00
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" data-md-component = "overlay" for = "__drawer" > < / label >
2018-04-27 00:09:55 +00:00
2018-10-27 20:58:54 +00:00
< a href = "#custom-errors" tabindex = "1" class = "md-skip" >
2018-04-27 00:09:55 +00:00
Skip to content
< / a >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header-nav md-grid" >
< div class = "md-flex" >
< div class = "md-flex__cell md-flex__cell--shrink" >
2018-09-13 23:54:10 +00:00
< a href = "../../.." title = "NGINX Ingress Controller" class = "md-header-nav__button md-logo" >
2018-04-27 00:09:55 +00:00
< i class = "md-icon" > public< / i >
< / a >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
2018-07-13 23:53:25 +00:00
< label class = "md-icon md-icon--menu md-header-nav__button" for = "__drawer" > < / label >
2018-04-27 00:09:55 +00:00
< / div >
< div class = "md-flex__cell md-flex__cell--stretch" >
< div class = "md-flex__ellipsis md-header-nav__title" data-md-component = "title" >
2019-03-02 18:14:04 +00:00
< span class = "md-header-nav__topic" >
NGINX Ingress Controller
< / span >
< span class = "md-header-nav__topic" >
Custom Errors
< / span >
2018-04-27 00:09:55 +00:00
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
2019-03-02 18:14:04 +00:00
< label class = "md-icon md-icon--search md-header-nav__button" for = "__search" > < / label >
2018-04-27 00:09:55 +00:00
< div class = "md-search" data-md-component = "search" role = "dialog" >
2018-07-13 23:53:25 +00:00
< label class = "md-search__overlay" for = "__search" > < / label >
2018-04-27 00:09:55 +00:00
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "query" data-md-state = "active" >
2018-07-13 23:53:25 +00:00
< label class = "md-icon md-search__icon" for = "__search" > < / label >
2018-04-27 00:09:55 +00:00
< button type = "reset" class = "md-icon md-search__icon" data-md-component = "reset" tabindex = "-1" >

< / button >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "result" >
< div class = "md-search-result__meta" >
Type to start searching
< / div >
< ol class = "md-search-result__list" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< div class = "md-header-nav__source" >
2019-03-02 18:14:04 +00:00
< a href = "https://github.com/kubernetes/ingress-nginx/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg viewBox = "0 0 24 24" width = "24" height = "24" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
2018-04-27 00:09:55 +00:00
< / div >
2019-03-02 18:14:04 +00:00
< div class = "md-source__repository" >
kubernetes/ingress-nginx
< / div >
< / a >
2018-04-27 00:09:55 +00:00
< / div >
< / div >
< / div >
< / nav >
< / header >
< div class = "md-container" >
< nav class = "md-tabs md-tabs--active" data-md-component = "tabs" >
< div class = "md-tabs__inner md-grid" >
< ul class = "md-tabs__list" >
2018-09-13 23:54:10 +00:00
< li class = "md-tabs__item" >
< a href = "../../.." title = "Welcome" class = "md-tabs__link" >
Welcome
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-tabs__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/" title = "Deployment" class = "md-tabs__link" >
2018-04-27 00:09:55 +00:00
Deployment
< / a >
< / li >
< li class = "md-tabs__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/" title = "User guide" class = "md-tabs__link" >
2018-04-27 00:09:55 +00:00
User guide
< / a >
< / li >
< li class = "md-tabs__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../" title = "Examples" class = "md-tabs__link md-tabs__link--active" >
2018-04-27 00:09:55 +00:00
Examples
< / a >
< / li >
< / ul >
< / div >
< / nav >
< main class = "md-main" >
< div class = "md-main__inner md-grid" data-md-component = "container" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" data-md-level = "0" >
2018-07-13 23:53:25 +00:00
< label class = "md-nav__title md-nav__title--site" for = "__drawer" >
2018-09-13 23:54:10 +00:00
< a href = "../../.." title = "NGINX Ingress Controller" class = "md-nav__button md-logo" >
2018-04-27 00:09:55 +00:00
< i class = "md-icon" > public< / i >
2018-08-04 22:29:33 +00:00
< / a >
2018-04-27 00:09:55 +00:00
NGINX Ingress Controller
< / label >
< div class = "md-nav__source" >
2019-03-02 18:14:04 +00:00
< a href = "https://github.com/kubernetes/ingress-nginx/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg viewBox = "0 0 24 24" width = "24" height = "24" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
2018-04-27 00:09:55 +00:00
< / div >
2019-03-02 18:14:04 +00:00
< div class = "md-source__repository" >
kubernetes/ingress-nginx
< / div >
< / a >
2018-04-27 00:09:55 +00:00
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
2018-09-13 23:54:10 +00:00
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-1" type = "checkbox" id = "nav-1" >
< label class = "md-nav__link" for = "nav-1" >
Welcome
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-1" >
Welcome
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../.." title = "Welcome" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Welcome
< / a >
< / li >
2018-09-13 23:54:10 +00:00
< li class = "md-nav__item" >
< a href = "../../../how-it-works/" title = "How it works" class = "md-nav__link" >
How it works
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../troubleshooting/" title = "Troubleshooting" class = "md-nav__link" >
Troubleshooting
< / a >
< / li >
2019-04-09 22:45:20 +00:00
< li class = "md-nav__item" >
< a href = "../../../kubectl-plugin/" title = "kubectl plugin" class = "md-nav__link" >
kubectl plugin
< / a >
< / li >
2018-09-13 23:54:10 +00:00
< li class = "md-nav__item" >
< a href = "../../../development/" title = "Development" class = "md-nav__link" >
Development
< / a >
< / li >
< / ul >
< / nav >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-2" type = "checkbox" id = "nav-2" >
< label class = "md-nav__link" for = "nav-2" >
Deployment
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-2" >
Deployment
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/" title = "Installation Guide" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Installation Guide
< / a >
< / li >
2018-09-04 23:47:40 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/baremetal/" title = "Bare-metal considerations" class = "md-nav__link" >
2018-09-04 23:47:40 +00:00
Bare-metal considerations
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/rbac/" title = "Role Based Access Control (RBAC)" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Role Based Access Control (RBAC)
< / a >
< / li >
2018-05-03 14:08:21 +00:00
2019-05-26 08:06:36 +00:00
< li class = "md-nav__item" >
< a href = "../../../deploy/validating-webhook/" title = "Validating Webhook (admission controller)" class = "md-nav__link" >
Validating Webhook (admission controller)
< / a >
< / li >
2018-05-03 14:08:21 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/upgrade/" title = "Upgrade" class = "md-nav__link" >
Upgrade
2018-05-03 14:08:21 +00:00
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3" type = "checkbox" id = "nav-3" >
< label class = "md-nav__link" for = "nav-3" >
User guide
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-3" >
User guide
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3-1" type = "checkbox" id = "nav-3-1" >
< label class = "md-nav__link" for = "nav-3-1" >
NGINX Configuration
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "2" >
< label class = "md-nav__title" for = "nav-3-1" >
NGINX Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/" title = "Introduction" class = "md-nav__link" >
Introduction
2018-04-27 00:09:55 +00:00
< / a >
< / li >
2019-03-08 00:36:59 +00:00
< li class = "md-nav__item" >
< a href = "../../../user-guide/basic-usage/" title = "Basic usage" class = "md-nav__link" >
Basic usage
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/annotations/" title = "Annotations" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Annotations
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/configmap/" title = "ConfigMap" class = "md-nav__link" >
ConfigMap
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/custom-template/" title = "Custom NGINX template" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Custom NGINX template
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/nginx-configuration/log-format/" title = "Log format" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Log format
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/cli-arguments/" title = "Command line arguments" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Command line arguments
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/custom-errors/" title = "Custom errors" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Custom errors
< / a >
< / li >
2018-05-03 14:08:21 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/default-backend/" title = "Default backend" class = "md-nav__link" >
2018-05-03 14:08:21 +00:00
Default backend
< / a >
< / li >
2018-11-22 02:35:18 +00:00
< li class = "md-nav__item" >
< a href = "../../../user-guide/exposing-tcp-udp-services/" title = "Exposing TCP and UDP services" class = "md-nav__link" >
Exposing TCP and UDP services
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-10-12 01:21:45 +00:00
< a href = "../../../user-guide/ingress-path-matching/" title = "Regular expressions in paths" class = "md-nav__link" >
Regular expressions in paths
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/external-articles/" title = "External Articles" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
External Articles
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/miscellaneous/" title = "Miscellaneous" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Miscellaneous
< / a >
< / li >
2018-08-22 19:35:46 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/monitoring/" title = "Prometheus and Grafana installation" class = "md-nav__link" >
2018-08-22 19:35:46 +00:00
Prometheus and Grafana installation
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/multiple-ingress/" title = "Multiple Ingress controllers" class = "md-nav__link" >
2018-05-03 14:08:21 +00:00
Multiple Ingress controllers
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/tls/" title = "TLS/HTTPS" class = "md-nav__link" >
2018-05-03 14:08:21 +00:00
TLS/HTTPS
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2018-11-22 02:35:18 +00:00
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3-12" type = "checkbox" id = "nav-3-12" >
2018-04-27 00:09:55 +00:00
2018-11-22 02:35:18 +00:00
< label class = "md-nav__link" for = "nav-3-12" >
2018-04-27 00:09:55 +00:00
Third party addons
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "2" >
2018-11-22 02:35:18 +00:00
< label class = "md-nav__title" for = "nav-3-12" >
2018-04-27 00:09:55 +00:00
Third party addons
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/third-party-addons/modsecurity/" title = "ModSecurity Web Application Firewall" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
ModSecurity Web Application Firewall
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../../user-guide/third-party-addons/opentracing/" title = "OpenTracing" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
OpenTracing
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-4" type = "checkbox" id = "nav-4" checked >
< label class = "md-nav__link" for = "nav-4" >
Examples
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-4" >
Examples
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../" title = "Introduction" class = "md-nav__link" >
Introduction
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../PREREQUISITES/" title = "Prerequisites" class = "md-nav__link" >
2018-05-03 14:08:21 +00:00
Prerequisites
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../affinity/cookie/" title = "Sticky Sessions" class = "md-nav__link" >
Sticky Sessions
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-4-4" type = "checkbox" id = "nav-4-4" >
< label class = "md-nav__link" for = "nav-4-4" >
Auth
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "2" >
< label class = "md-nav__title" for = "nav-4-4" >
Auth
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../auth/basic/" title = "Basic Authentication" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Basic Authentication
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../auth/client-certs/" title = "Client Certificate Authentication" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Client Certificate Authentication
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../auth/external-auth/" title = "External Basic Authentication" class = "md-nav__link" >
2018-08-30 19:50:29 +00:00
External Basic Authentication
2018-04-27 00:09:55 +00:00
< / a >
< / li >
2018-05-03 14:08:21 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../auth/oauth-external-auth/" title = "External OAUTH Authentication" class = "md-nav__link" >
2018-08-30 19:50:29 +00:00
External OAUTH Authentication
2018-05-03 14:08:21 +00:00
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-4-5" type = "checkbox" id = "nav-4-5" checked >
< label class = "md-nav__link" for = "nav-4-5" >
Customization
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "2" >
< label class = "md-nav__title" for = "nav-4-5" >
Customization
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../configuration-snippets/" title = "Configuration Snippets" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Configuration Snippets
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../custom-configuration/" title = "Custom Configuration" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Custom Configuration
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
2018-07-13 23:53:25 +00:00
< input class = "md-toggle md-nav__toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
2018-04-27 00:09:55 +00:00
2018-07-13 23:53:25 +00:00
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
2018-06-12 23:26:21 +00:00
Custom Errors
< / label >
2018-04-27 00:09:55 +00:00
< a href = "./" title = "Custom Errors" class = "md-nav__link md-nav__link--active" >
Custom Errors
< / a >
2018-06-12 23:26:21 +00:00
< nav class = "md-nav md-nav--secondary" >
2018-07-13 23:53:25 +00:00
< label class = "md-nav__title" for = "__toc" > Table of contents< / label >
2018-06-12 23:26:21 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#customized-default-backend" title = "Customized default backend" class = "md-nav__link" >
Customized default backend
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#ingress-controller-configuration" title = "Ingress controller configuration" class = "md-nav__link" >
Ingress controller configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#testing-error-pages" title = "Testing error pages" class = "md-nav__link" >
Testing error pages
< / a >
< / li >
< / ul >
< / nav >
2018-04-27 00:09:55 +00:00
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../custom-headers/" title = "Custom Headers" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Custom Headers
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../external-auth-headers/" title = "External authentication" class = "md-nav__link" >
External authentication
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../ssl-dh-param/" title = "Custom DH parameters for perfect forward secrecy" class = "md-nav__link" >
2018-05-03 14:08:21 +00:00
Custom DH parameters for perfect forward secrecy
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../sysctl/" title = "Sysctl tuning" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Sysctl tuning
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../docker-registry/" title = "Docker registry" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Docker registry
< / a >
< / li >
2018-05-12 01:26:30 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../grpc/" title = "gRPC" class = "md-nav__link" >
2018-05-12 01:26:30 +00:00
gRPC
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../multi-tls/" title = "Multi TLS certificate termination" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Multi TLS certificate termination
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../rewrite/" title = "Rewrite" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Rewrite
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../static-ip/" title = "Static IPs" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Static IPs
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../../tls-termination/" title = "TLS termination" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
TLS termination
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" >
2018-07-13 23:53:25 +00:00
< label class = "md-nav__title" for = "__toc" > Table of contents< / label >
2018-06-12 23:26:21 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#customized-default-backend" title = "Customized default backend" class = "md-nav__link" >
Customized default backend
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#ingress-controller-configuration" title = "Ingress controller configuration" class = "md-nav__link" >
Ingress controller configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#testing-error-pages" title = "Testing error pages" class = "md-nav__link" >
Testing error pages
< / a >
< / li >
< / ul >
2018-04-27 00:09:55 +00:00
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" >
< article class = "md-content__inner md-typeset" >
< a href = "https://github.com/kubernetes/ingress-nginx/edit/master/docs/examples/customization/custom-errors/README.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
< h1 id = "custom-errors" > Custom Errors< a class = "headerlink" href = "#custom-errors" title = "Permanent link" > ¶ < / a > < / h1 >
2018-06-12 23:26:21 +00:00
< p > This example demonstrates how to use a custom backend to render custom error pages.< / p >
< h2 id = "customized-default-backend" > Customized default backend< a class = "headerlink" href = "#customized-default-backend" title = "Permanent link" > ¶ < / a > < / h2 >
< p > First, create the custom < code class = "codehilite" > default-backend< / code > . It will be used by the Ingress controller later on.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ kubectl create -f custom-default-backend.yaml
2018-04-27 00:09:55 +00:00
service < span class = "s2" > " nginx-errors" < / span > created
2018-06-12 23:26:21 +00:00
deployment.apps < span class = "s2" > " nginx-errors" < / span > created
2018-04-27 00:09:55 +00:00
< / pre > < / div >
2018-06-12 23:26:21 +00:00
< p > This should have created a Deployment and a Service with the name < code class = "codehilite" > nginx-errors< / code > .< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ kubectl get deploy,svc
2018-06-12 23:26:21 +00:00
NAME DESIRED CURRENT READY AGE
deployment.apps/nginx-errors < span class = "m" > 1< / span > < span class = "m" > 1< / span > < span class = "m" > 1< / span > 10s
2018-04-27 00:09:55 +00:00
2018-06-12 23:26:21 +00:00
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT< span class = "o" > (< / span > S< span class = "o" > )< / span > AGE
service/nginx-errors ClusterIP < span class = "m" > 10< / span > .0.0.12 < none> < span class = "m" > 80< / span > /TCP 10s
2018-04-27 00:09:55 +00:00
< / pre > < / div >
2018-06-12 23:26:21 +00:00
< h2 id = "ingress-controller-configuration" > Ingress controller configuration< a class = "headerlink" href = "#ingress-controller-configuration" title = "Permanent link" > ¶ < / a > < / h2 >
2018-10-07 19:44:09 +00:00
< p > If you do not already have an instance of the NGINX Ingress controller running, deploy it according to the
2018-09-13 23:54:10 +00:00
< a href = "../../../deploy/" > deployment guide< / a > , then follow these steps:< / p >
2018-06-12 23:26:21 +00:00
< ol >
< li >
< p > Edit the < code class = "codehilite" > nginx-ingress-controller< / code > Deployment and set the value of the < code class = "codehilite" > --default-backend< / code > flag to the name of the
newly created error backend.< / p >
< / li >
< li >
< p > Edit the < code class = "codehilite" > nginx-configuration< / code > ConfigMap and create the key < code class = "codehilite" > custom-http-errors< / code > with a value of < code class = "codehilite" > 404,503< / code > .< / p >
< / li >
< li >
< p > Take note of the IP address assigned to the NGINX Ingress controller Service.
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ kubectl get svc ingress-nginx
2018-09-04 23:47:40 +00:00
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT< span class = "o" > (< / span > S< span class = "o" > )< / span > AGE
ingress-nginx ClusterIP < span class = "m" > 10< / span > .0.0.13 < none> < span class = "m" > 80< / span > /TCP,443/TCP 10m
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-06-12 23:26:21 +00:00
< / li >
< / ol >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > The < code class = "codehilite" > ingress-nginx< / code > Service is of type < code class = "codehilite" > ClusterIP< / code > in this example. This may vary depending on your environment.
Make sure you can use the Service to reach NGINX before proceeding with the rest of this example.< / p >
< / div >
< h2 id = "testing-error-pages" > Testing error pages< a class = "headerlink" href = "#testing-error-pages" title = "Permanent link" > ¶ < / a > < / h2 >
< p > Let us send a couple of HTTP requests using cURL and validate everything is working as expected.< / p >
< p > A request to the default backend returns a 404 error with a custom message:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ curl -D- http://10.0.0.13/
2018-06-12 23:26:21 +00:00
HTTP/1.1 404 Not Found
Server: nginx/1.13.12
Date: Tue, 12 Jun 2018 19:11:24 GMT
Content-Type: */*
Transfer-Encoding: chunked
Connection: keep-alive
< span class = "nt" > < span> < / span > The page you' re looking for could not be found.< span class = "nt" > < /span> < / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
2018-06-12 23:26:21 +00:00
< p > A request with a custom < code class = "codehilite" > Accept< / code > header returns the corresponding document type (JSON):< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ curl -D- -H < span class = "s1" > ' Accept: application/json' < / span > http://10.0.0.13/
2018-06-12 23:26:21 +00:00
HTTP/1.1 < span class = "m" > 404< / span > Not Found
Server: nginx/1.13.12
Date: Tue, < span class = "m" > 12< / span > Jun < span class = "m" > 2018< / span > < span class = "m" > 19< / span > :12:36 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding
2018-04-27 00:09:55 +00:00
< span class = "o" > {< / span > < span class = "s2" > " message" < / span > : < span class = "s2" > " The page you' re looking for could not be found" < / span > < span class = "o" > }< / span >
< / pre > < / div >
2018-06-12 23:26:21 +00:00
< p > To go further with this example, feel free to deploy your own applications and Ingress objects, and validate that the
responses are still in the correct format when a backend returns 503 (eg. if you scale a Deployment down to 0 replica).< / p >
2018-04-27 00:09:55 +00:00
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" >
2018-09-13 23:54:10 +00:00
< a href = "../custom-configuration/" title = "Custom Configuration" class = "md-flex md-footer-nav__link md-footer-nav__link--prev" rel = "prev" >
2018-04-27 00:09:55 +00:00
< div class = "md-flex__cell md-flex__cell--shrink" >
< i class = "md-icon md-icon--arrow-back md-footer-nav__button" > < / i >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" >
< span class = "md-flex__ellipsis" >
< span class = "md-footer-nav__direction" >
Previous
< / span >
Custom Configuration
< / span >
< / div >
< / a >
2018-09-13 23:54:10 +00:00
< a href = "../custom-headers/" title = "Custom Headers" class = "md-flex md-footer-nav__link md-footer-nav__link--next" rel = "next" >
2018-04-27 00:09:55 +00:00
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" >
< span class = "md-flex__ellipsis" >
< span class = "md-footer-nav__direction" >
Next
< / span >
Custom Headers
< / span >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< i class = "md-icon md-icon--arrow-forward md-footer-nav__button" > < / i >
< / div >
< / a >
< / nav >
< / div >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-footer-copyright" >
powered by
2018-07-13 23:53:25 +00:00
< a href = "https://www.mkdocs.org" > MkDocs< / a >
2018-04-27 00:09:55 +00:00
and
< a href = "https://squidfunk.github.io/mkdocs-material/" >
Material for MkDocs< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
2019-03-02 18:14:04 +00:00
< script src = "../../../assets/javascripts/application.d9aa80ab.js" > < / script >
2018-04-27 00:09:55 +00:00
2018-09-13 23:54:10 +00:00
< script > app . initialize ( { version : "1.0.4" , url : { base : "../../.." } } ) < / script >
2018-04-27 00:09:55 +00:00
< / body >
< / html >
