2018-04-27 00:09:55 +00:00
<!DOCTYPE html>
< 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\-]+" >
< link rel = "shortcut icon" href = "../assets/images/favicon.png" >
2018-12-04 15:07:57 +00:00
< meta name = "generator" content = "mkdocs-1.0.4, mkdocs-material-3.1.0" >
2018-04-27 00:09:55 +00:00
2018-09-13 23:54:10 +00:00
< title > Development - NGINX Ingress Controller< / title >
2018-04-27 00:09:55 +00:00
2018-12-04 15:07:57 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/application.11e41852.css" >
2018-04-27 00:09:55 +00:00
2018-08-04 22:29:33 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/application-palette.22915126.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
2018-12-04 15:07:57 +00:00
< script src = "../assets/javascripts/modernizr.20ef595d.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-07-13 23:53:25 +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-04-27 12:02:43 +00:00
< link rel = "stylesheet" href = "../extra.css" >
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 = "#developing-for-nginx-ingress-controller" 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" >
< a href = ".." title = "NGINX Ingress Controller" class = "md-header-nav__button md-logo" >
< 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" >
< span class = "md-header-nav__topic" >
NGINX Ingress Controller
< / span >
< span class = "md-header-nav__topic" >
2018-09-13 23:54:10 +00:00
Development
2018-04-27 00:09:55 +00:00
< / span >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
2018-07-13 23:53:25 +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" >
< 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" >
2018-07-13 23:53:25 +00:00
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
2018-04-27 00:09:55 +00:00
< / svg >
< / div >
< div class = "md-source__repository" >
kubernetes/ingress-nginx
< / div >
< / a >
< / div >
< / div >
< / div >
< / nav >
< / header >
< div class = "md-container" >
2018-09-13 23:54:10 +00:00
< nav class = "md-tabs md-tabs--active" data-md-component = "tabs" >
2018-04-27 00:09:55 +00:00
< 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 md-tabs__link--active" >
Welcome
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-tabs__item" >
< a href = "../deploy/" title = "Deployment" class = "md-tabs__link" >
Deployment
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../user-guide/nginx-configuration/" title = "User guide" class = "md-tabs__link" >
User guide
< / a >
< / li >
< li class = "md-tabs__item" >
2018-05-03 14:08:21 +00:00
< a href = "../examples/" title = "Examples" class = "md-tabs__link" >
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-08-04 22:29:33 +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" >
< 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" >
2018-07-13 23:53:25 +00:00
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
2018-04-27 00:09:55 +00:00
< / svg >
< / div >
< div class = "md-source__repository" >
kubernetes/ingress-nginx
< / div >
< / a >
< / 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--active md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-1" type = "checkbox" id = "nav-1" checked >
< 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" >
< a href = ".." title = "Welcome" class = "md-nav__link" >
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 >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Development
< / label >
< a href = "./" title = "Development" class = "md-nav__link md-nav__link--active" >
Development
< / a >
< nav class = "md-nav md-nav--secondary" >
< label class = "md-nav__title" for = "__toc" > Table of contents< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#quick-start" title = "Quick Start" class = "md-nav__link" >
Quick Start
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#getting-the-code" title = "Getting the code" class = "md-nav__link" >
Getting the code
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#initial-developer-environment-build" title = "Initial developer environment build" class = "md-nav__link" >
Initial developer environment build
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#updating-the-deployment" title = "Updating the deployment" class = "md-nav__link" >
Updating the deployment
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#dependencies" title = "Dependencies" class = "md-nav__link" >
Dependencies
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#building" title = "Building" class = "md-nav__link" >
Building
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#nginx-controller" title = "Nginx Controller" class = "md-nav__link" >
Nginx Controller
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#deploying" title = "Deploying" class = "md-nav__link" >
Deploying
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#testing" title = "Testing" class = "md-nav__link" >
Testing
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#releasing" title = "Releasing" class = "md-nav__link" >
Releasing
< / a >
< / li >
< / ul >
< / nav >
< / 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" >
< a href = "../deploy/" title = "Installation Guide" class = "md-nav__link" >
Installation Guide
< / a >
< / li >
2018-09-04 23:47:40 +00:00
< li class = "md-nav__item" >
< a href = "../deploy/baremetal/" title = "Bare-metal considerations" class = "md-nav__link" >
Bare-metal considerations
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
< a href = "../deploy/rbac/" title = "Role Based Access Control (RBAC)" class = "md-nav__link" >
Role Based Access Control (RBAC)
< / 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 >
< li class = "md-nav__item" >
< a href = "../user-guide/nginx-configuration/annotations/" title = "Annotations" class = "md-nav__link" >
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" >
< a href = "../user-guide/nginx-configuration/custom-template/" title = "Custom NGINX template" class = "md-nav__link" >
Custom NGINX template
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../user-guide/nginx-configuration/log-format/" title = "Log format" class = "md-nav__link" >
Log format
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../user-guide/cli-arguments/" title = "Command line arguments" class = "md-nav__link" >
Command line arguments
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../user-guide/custom-errors/" title = "Custom errors" class = "md-nav__link" >
Custom errors
< / a >
< / li >
2018-05-03 14:08:21 +00:00
< li class = "md-nav__item" >
< a href = "../user-guide/default-backend/" title = "Default backend" class = "md-nav__link" >
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" >
< a href = "../user-guide/external-articles/" title = "External Articles" class = "md-nav__link" >
External Articles
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../user-guide/miscellaneous/" title = "Miscellaneous" class = "md-nav__link" >
Miscellaneous
< / a >
< / li >
2018-08-22 19:35:46 +00:00
< li class = "md-nav__item" >
< a href = "../user-guide/monitoring/" title = "Prometheus and Grafana installation" class = "md-nav__link" >
Prometheus and Grafana installation
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
2018-05-03 14:08:21 +00:00
< a href = "../user-guide/multiple-ingress/" title = "Multiple Ingress controllers" class = "md-nav__link" >
Multiple Ingress controllers
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-05-03 14:08:21 +00:00
< a href = "../user-guide/tls/" title = "TLS/HTTPS" class = "md-nav__link" >
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" >
< a href = "../user-guide/third-party-addons/modsecurity/" title = "ModSecurity Web Application Firewall" class = "md-nav__link" >
ModSecurity Web Application Firewall
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../user-guide/third-party-addons/opentracing/" title = "OpenTracing" class = "md-nav__link" >
OpenTracing
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-4" type = "checkbox" id = "nav-4" >
< 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 = "../examples/" title = "Introduction" class = "md-nav__link" >
Introduction
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2018-05-03 14:08:21 +00:00
< a href = "../examples/PREREQUISITES/" title = "Prerequisites" class = "md-nav__link" >
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 = "../examples/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 = "../examples/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 = "../examples/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 = "../examples/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 = "../examples/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--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-4-5" type = "checkbox" id = "nav-4-5" >
< 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 = "../examples/customization/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 = "../examples/customization/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" >
2018-09-13 23:54:10 +00:00
< a href = "../examples/customization/custom-errors/" title = "Custom Errors" class = "md-nav__link" >
2018-04-27 00:09:55 +00:00
Custom Errors
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../examples/customization/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 = "../examples/customization/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 = "../examples/customization/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 = "../examples/customization/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 = "../examples/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 = "../examples/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 = "../examples/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 = "../examples/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 = "../examples/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 = "../examples/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-04-27 00:09:55 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#quick-start" title = "Quick Start" class = "md-nav__link" >
Quick Start
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
2018-05-01 18:15:43 +00:00
< li class = "md-nav__item" >
< a href = "#getting-the-code" title = "Getting the code" class = "md-nav__link" >
Getting the code
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
< a href = "#initial-developer-environment-build" title = "Initial developer environment build" class = "md-nav__link" >
Initial developer environment build
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#updating-the-deployment" title = "Updating the deployment" class = "md-nav__link" >
Updating the deployment
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#dependencies" title = "Dependencies" class = "md-nav__link" >
Dependencies
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#building" title = "Building" class = "md-nav__link" >
Building
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#nginx-controller" title = "Nginx Controller" class = "md-nav__link" >
Nginx Controller
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#deploying" title = "Deploying" class = "md-nav__link" >
Deploying
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#testing" title = "Testing" class = "md-nav__link" >
Testing
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#releasing" title = "Releasing" class = "md-nav__link" >
Releasing
< / a >
< / li >
< / ul >
< / 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/development.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
2018-05-01 18:15:43 +00:00
< h1 id = "developing-for-nginx-ingress-controller" > Developing for NGINX Ingress Controller< a class = "headerlink" href = "#developing-for-nginx-ingress-controller" title = "Permanent link" > ¶ < / a > < / h1 >
2018-04-27 00:09:55 +00:00
< p > This document explains how to get started with developing for NGINX Ingress controller.
It includes how to build, test, and release ingress controllers.< / p >
< h2 id = "quick-start" > Quick Start< a class = "headerlink" href = "#quick-start" title = "Permanent link" > ¶ < / a > < / h2 >
2018-05-01 18:15:43 +00:00
< h3 id = "getting-the-code" > Getting the code< a class = "headerlink" href = "#getting-the-code" title = "Permanent link" > ¶ < / a > < / h3 >
< p > The code must be checked out as a subdirectory of k8s.io, and not github.com.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > mkdir -p $GOPATH/src/k8s.io
2018-05-01 18:15:43 +00:00
cd $GOPATH/src/k8s.io
# Replace " $YOUR_GITHUB_USERNAME" below with your github username
git clone https://github.com/$YOUR_GITHUB_USERNAME/ingress-nginx.git
cd ingress-nginx
< / pre > < / div >
2018-04-27 00:09:55 +00:00
< h3 id = "initial-developer-environment-build" > Initial developer environment build< a class = "headerlink" href = "#initial-developer-environment-build" title = "Permanent link" > ¶ < / a > < / h3 >
2018-04-29 15:47:17 +00:00
< blockquote >
< p > < strong > Prequisites< / strong > : Minikube must be installed.
See < a href = "https://github.com/kubernetes/minikube/releases" > releases< / a > for installation instructions. < / p >
< / blockquote >
2018-04-27 00:09:55 +00:00
< p > If you are using < strong > MacOS< / strong > and deploying to < strong > minikube< / strong > , the following command will build the local nginx controller container image and deploy the ingress controller onto a minikube cluster with RBAC enabled in the namespace < code class = "codehilite" > ingress-nginx< / code > :< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ make dev-env
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< h3 id = "updating-the-deployment" > Updating the deployment< a class = "headerlink" href = "#updating-the-deployment" title = "Permanent link" > ¶ < / a > < / h3 >
2018-09-04 23:47:40 +00:00
< p > The nginx controller container image can be rebuilt using:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ < span class = "nv" > ARCH< / span > < span class = "o" > =< / span > amd64 < span class = "nv" > TAG< / span > < span class = "o" > =< / span > dev < span class = "nv" > REGISTRY< / span > < span class = "o" > =< / span > < span class = "nv" > $USER< / span > /ingress-controller make build container
< / pre > < / div > < / p >
2018-09-04 23:47:40 +00:00
< p > The image will only be used by pods created after the rebuild. To delete old pods which will cause new ones to spin up:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ kubectl get pods -n ingress-nginx
2018-04-27 00:09:55 +00:00
$ kubectl delete pod -n ingress-nginx nginx-ingress-controller-< unique-pod-id>
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-04-27 00:09:55 +00:00
< h2 id = "dependencies" > Dependencies< a class = "headerlink" href = "#dependencies" title = "Permanent link" > ¶ < / a > < / h2 >
< p > The build uses dependencies in the < code class = "codehilite" > vendor< / code > directory, which
must be installed before building a binary/image. Occasionally, you
might need to update the dependencies.< / p >
< p > This guide requires you to install the < a href = "https://github.com/golang/dep" > dep< / a > dependency tool.< / p >
< p > Check the version of < code class = "codehilite" > dep< / code > you are using and make sure it is up to date.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > dep version
2018-04-27 00:09:55 +00:00
< span class = "go" > dep:< / span >
< span class = "go" > version : devel< / span >
< span class = "go" > build date : < / span >
< span class = "go" > git hash : < / span >
< span class = "go" > go version : go1.9< / span >
< span class = "go" > go compiler : gc< / span >
< span class = "go" > platform : linux/amd64< / span >
< / pre > < / div >
< p > If you have an older version of < code class = "codehilite" > dep< / code > , you can update it as follows:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > go get -u github.com/golang/dep
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< p > This will automatically save the dependencies to the < code class = "codehilite" > vendor/< / code > directory.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nb" > cd< / span > < span class = "nv" > $GOPATH< / span > /src/k8s.io/ingress-nginx
2018-04-27 00:09:55 +00:00
< span class = "gp" > $< / span > dep ensure
< span class = "gp" > $< / span > dep ensure -update
< span class = "gp" > $< / span > dep prune
< / pre > < / div >
< h2 id = "building" > Building< a class = "headerlink" href = "#building" title = "Permanent link" > ¶ < / a > < / h2 >
< p > All ingress controllers are built through a Makefile. Depending on your
requirements you can build a raw server binary, a local container image,
or push an image to a remote repository.< / p >
< p > In order to use your local Docker, you may need to set the following environment variables:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > #< / span > < span class = "s2" > " gcloud docker" < / span > < span class = "o" > (< / span > default< span class = "o" > )< / span > or < span class = "s2" > " docker" < / span >
2018-04-27 00:09:55 +00:00
< span class = "gp" > $< / span > < span class = "nb" > export< / span > < span class = "nv" > DOCKER< / span > < span class = "o" > =< / span > < docker>
< span class = "gp" > #< / span > < span class = "s2" > " quay.io/kubernetes-ingress-controller" < / span > < span class = "o" > (< / span > default< span class = "o" > )< / span > , < span class = "s2" > " index.docker.io" < / span > , or your own registry
< span class = "gp" > $< / span > < span class = "nb" > export< / span > < span class = "nv" > REGISTRY< / span > < span class = "o" > =< / span > < your-docker-registry>
< / pre > < / div >
< p > To find the registry simply run: < code class = "codehilite" > docker system info | grep Registry< / code > < / p >
< h3 id = "nginx-controller" > Nginx Controller< a class = "headerlink" href = "#nginx-controller" title = "Permanent link" > ¶ < / a > < / h3 >
2018-09-04 23:47:40 +00:00
< p > Build a raw server binary
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > make build
< / pre > < / div > < / p >
2018-04-27 00:09:55 +00:00
< p > < a href = "https://github.com/kubernetes/ingress-nginx/issues/387" > TODO< / a > : add more specific instructions needed for raw server binary.< / p >
< p > Build a local container image< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nv" > TAG< / span > < span class = "o" > =< / span > < tag> < span class = "nv" > REGISTRY< / span > < span class = "o" > =< / span > < span class = "nv" > $USER< / span > /ingress-controller make docker-build
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< p > Push the container image to a remote repository< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nv" > TAG< / span > < span class = "o" > =< / span > < tag> < span class = "nv" > REGISTRY< / span > < span class = "o" > =< / span > < span class = "nv" > $USER< / span > /ingress-controller make docker-push
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< h2 id = "deploying" > Deploying< a class = "headerlink" href = "#deploying" title = "Permanent link" > ¶ < / a > < / h2 >
< p > There are several ways to deploy the ingress controller onto a cluster.
2018-09-13 23:54:10 +00:00
Please check the < a href = "./deploy" > deployment guide< / a > < / p >
2018-04-27 00:09:55 +00:00
< h2 id = "testing" > Testing< a class = "headerlink" href = "#testing" title = "Permanent link" > ¶ < / a > < / h2 >
< p > To run unit-tests, just run< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nb" > cd< / span > < span class = "nv" > $GOPATH< / span > /src/k8s.io/ingress-nginx
2018-04-27 00:09:55 +00:00
< span class = "gp" > $< / span > make < span class = "nb" > test< / span >
< / pre > < / div >
< p > If you have access to a Kubernetes cluster, you can also run e2e tests using ginkgo.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nb" > cd< / span > < span class = "nv" > $GOPATH< / span > /src/k8s.io/ingress-nginx
2018-04-27 00:09:55 +00:00
< span class = "gp" > $< / span > make e2e-test
< / pre > < / div >
< p > To run unit-tests for lua code locally, run:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > < span class = "nb" > cd< / span > < span class = "nv" > $GOPATH< / span > /src/k8s.io/ingress-nginx
2018-04-27 00:09:55 +00:00
< span class = "gp" > $< / span > ./rootfs/etc/nginx/lua/test/up.sh
< span class = "gp" > $< / span > make lua-test
< / pre > < / div >
< p > Lua tests are located in < code class = "codehilite" > $GOPATH/src/k8s.io/ingress-nginx/rootfs/etc/nginx/lua/test< / code > . When creating a new test file it must follow the naming convention < code class = "codehilite" > < mytest> _test.lua< / code > or it will be ignored. < / p >
< h2 id = "releasing" > Releasing< a class = "headerlink" href = "#releasing" title = "Permanent link" > ¶ < / a > < / h2 >
< p > All Makefiles will produce a release binary, as shown above. To publish this
to a wider Kubernetes user base, push the image to a container registry, like
< a href = "https://cloud.google.com/container-registry/" > gcr.io< / a > . All release images are hosted under < code class = "codehilite" > gcr.io/google_containers< / code > and
tagged according to a < a href = "http://semver.org/" > semver< / a > scheme.< / p >
2018-09-04 23:47:40 +00:00
< p > An example release might look like:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ make release
< / pre > < / div > < / p >
2018-04-27 00:09:55 +00:00
< p > Please follow these guidelines to cut a release:< / p >
< ul >
< li > Update the < a href = "https://help.github.com/articles/creating-releases/" > release< / a >
page with a short description of the major changes that correspond to a given
image tag.< / li >
< li > Cut a release branch, if appropriate. Release branches follow the format of
< code class = "codehilite" > controller-release-version< / code > . Typically, pre-releases are cut from HEAD.
All major feature work is done in HEAD. Specific bug fixes are
cherry-picked into a release branch.< / li >
< li > If you're not confident about the stability of the code,
< a href = "https://help.github.com/articles/working-with-tags/" > tag< / a > it as alpha or beta.
Typically, a release branch should have stable code.< / li >
< / ul >
< / 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 = "../troubleshooting/" title = "Troubleshooting" 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 >
2018-09-13 23:54:10 +00:00
Troubleshooting
2018-04-27 00:09:55 +00:00
< / span >
< / div >
< / a >
2018-09-13 23:54:10 +00:00
< a href = "../deploy/" title = "Installation Guide" 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 >
2018-09-13 23:54:10 +00:00
Installation Guide
2018-04-27 00:09:55 +00:00
< / 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 >
2018-12-04 15:07:57 +00:00
< script src = "../assets/javascripts/application.9e1f3b71.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
2018-12-04 15:07:57 +00:00
< script > ! function ( e , a , t , n , o , c , i ) { e . GoogleAnalyticsObject = o , e . ga = e . ga || function ( ) { ( e . ga . q = e . ga . q || [ ] ) . push ( arguments ) } , e . ga . l = 1 * new Date , c = a . createElement ( t ) , i = a . getElementsByTagName ( t ) [ 0 ] , c . async = 1 , c . src = "https://www.google-analytics.com/analytics.js" , i . parentNode . insertBefore ( c , i ) } ( window , document , "script" , 0 , "ga" ) , ga ( "create" , "UA-118407822-1" , "kubernetes.github.io" ) , ga ( "set" , "anonymizeIp" , ! 0 ) , ga ( "send" , "pageview" ) ; var links = document . getElementsByTagName ( "a" ) ; if ( Array . prototype . map . call ( links , function ( a ) { a . host != document . location . host && a . addEventListener ( "click" , function ( ) { var e = a . getAttribute ( "data-md-action" ) || "follow" ; ga ( "send" , "event" , "outbound" , e , a . href ) } ) } ) , document . forms . search ) { var query = document . forms . search . query ; query . addEventListener ( "blur" , function ( ) { if ( this . value ) { var e = document . location . pathname ; ga ( "send" , "pageview" , e + "?q=" + this . value ) } } ) } < / script >
2018-04-30 16:37:53 +00:00
2018-04-27 00:09:55 +00:00
< / body >
< / html >
