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\-]+" >
< 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 > Command line arguments - 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-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
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 = "#command-line-arguments" 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" >
2019-03-02 18:14:04 +00:00
< span class = "md-header-nav__topic" >
NGINX Ingress Controller
< / span >
< span class = "md-header-nav__topic" >
Command line arguments
< / 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" >
< a href = "../../deploy/" title = "Deployment" class = "md-tabs__link" >
Deployment
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../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" >
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" >
< 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 >
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" >
< 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
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--active md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3" type = "checkbox" id = "nav-3" checked >
< 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 = "../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 = "../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" >
< a href = "../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 = "../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 = "../nginx-configuration/custom-template/" title = "Custom NGINX template" class = "md-nav__link" >
Custom NGINX template
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../nginx-configuration/log-format/" title = "Log format" class = "md-nav__link" >
Log format
< / a >
< / li >
< / ul >
< / nav >
< / 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
< a href = "./" title = "Command line arguments" class = "md-nav__link md-nav__link--active" >
Command line arguments
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../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 = "../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 = "../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 = "../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 = "../external-articles/" title = "External Articles" class = "md-nav__link" >
External Articles
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../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 = "../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 = "../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 = "../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 = "../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 = "../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" >
< / 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/user-guide/cli-arguments.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
< h1 id = "command-line-arguments" > Command line arguments< a class = "headerlink" href = "#command-line-arguments" title = "Permanent link" > ¶ < / a > < / h1 >
2018-06-11 12:19:25 +00:00
< p > The following command line arguments are accepted by the Ingress controller executable.< / p >
2018-09-13 23:54:10 +00:00
< p > They are set in the container spec of the < code class = "codehilite" > nginx-ingress-controller< / code > Deployment manifest< / p >
2018-04-27 00:09:55 +00:00
< table >
< thead >
< tr >
< th > Argument< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --alsologtostderr< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > log to standard error as well as files< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --annotations-prefix string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io")< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --apiserver-host string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --configmap string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Name of the ConfigMap containing custom global configurations for the controller.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --default-backend-service string< / code > < / td >
2018-10-27 20:58:54 +00:00
< td > Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service. If not specified, a 404 page will be returned directly from NGINX.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --default-server-port int< / code > < / td >
2018-09-27 01:20:39 +00:00
< td > When < code class = "codehilite" > default-backend-service< / code > is not specified or specified service does not have any endpoint, a local endpoint with this port will be used to serve 404 page from inside Nginx.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --default-ssl-certificate string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name".< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2019-03-12 20:50:38 +00:00
< td > < code class = "codehilite" > --disable-catch-all< / code > < / td >
< td > Disable support for catch-all Ingresses.< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --election-id string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Election id to use for Ingress status updates. (default "ingress-controller-leader")< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --enable-dynamic-certificates< / code > < / td >
2019-03-18 20:30:24 +00:00
< td > Dynamically serves certificates instead of reloading NGINX when certificates are created, updated, or deleted. Currently does not support OCSP stapling, so --enable-ssl-chain-completion must be turned off (default behaviour). Assuming the certificate is generated with a 2048 bit RSA key/cert pair, this feature can store roughly 5000 certificates. (enabled by default)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --enable-ssl-chain-completion< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Autocomplete SSL certificate chains with missing intermediate CA certificates. A valid certificate chain is required to enable OCSP stapling. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default true)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --enable-ssl-passthrough< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Enable SSL Passthrough.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --health-check-path string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz")< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-11-02 15:06:41 +00:00
< td > < code class = "codehilite" > --health-check-timeout duration< / code > < / td >
< td > Time limit, in seconds, for a probe to health-check-path to succeed. (default 10)< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --healthz-port int< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Port to use for the healthz endpoint. (default 10254)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --http-port int< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Port to use for servicing HTTP traffic. (default 80)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --https-port int< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Port to use for servicing HTTPS traffic. (default 443)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --ingress-class string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Name of the ingress class this controller satisfies. The class of an Ingress object is set using the annotation "kubernetes.io/ingress.class". All ingress classes are satisfied if this parameter is left empty.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --kubeconfig string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Path to a kubeconfig file containing authorization and API server information.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --log_backtrace_at traceLocation< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > when logging hits line file:N, emit a stack trace (default :0)< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --log_dir string< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > If non-empty, write log files in this directory< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --logtostderr< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > log to standard error instead of files (default true)< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --profiling< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > Enable profiling via web interface host:port/debug/pprof/ (default true)< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --publish-service string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it satisfies.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --publish-status-address string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --report-node-internal-ip-address< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --ssl-passthrough-proxy-port int< / code > < / td >
2018-06-25 20:45:54 +00:00
< td > Port to use internally for SSL Passthrough. (default 442)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --stderrthreshold severity< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > logs at or above this threshold go to stderr (default 2)< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --sync-period duration< / code > < / td >
< td > Period at which the controller forces the repopulation of its local object stores. Disabled by default.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --sync-rate-limit float32< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > Define the sync frequency upper limit (default 0.3)< / td >
< / tr >
< tr >
2018-11-22 02:35:18 +00:00
< td > < code class = "codehilite" > --tcp-services-configmap string< / code > < / td >
< td > Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic.< / td >
< / tr >
< tr >
< td > < code class = "codehilite" > --udp-services-configmap string< / code > < / td >
< td > Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number.< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --update-status< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --update-status-on-shutdown< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true)< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > -v< / code > , < code class = "codehilite" > --v Level< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > log level for V logs< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --version< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Show release information about the NGINX Ingress controller and exit.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --vmodule moduleSpec< / code > < / td >
2018-04-27 00:09:55 +00:00
< td > comma-separated list of pattern=N settings for file-filtered logging< / td >
< / tr >
< tr >
2018-09-13 23:54:10 +00:00
< td > < code class = "codehilite" > --watch-namespace string< / code > < / td >
2018-06-11 12:19:25 +00:00
< td > Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty.< / td >
2018-04-27 00:09:55 +00:00
< / tr >
2019-05-26 08:06:36 +00:00
< tr >
< td > < code class = "codehilite" > --disable-catch-all< / code > < / td >
< td > Disable support for catch-all Ingresses.< / td >
< / tr >
< tr >
< td > < code class = "codehilite" > --validating-webhook< / code > < / td >
< td > The address to start an admission controller on< / td >
< / tr >
< tr >
< td > < code class = "codehilite" > --validating-webhook-certificate< / code > < / td >
< td > The certificate the webhook is using for its TLS handling< / td >
< / tr >
< tr >
< td > < code class = "codehilite" > --validating-webhook-key< / code > < / td >
< td > The key the webhook is using for its TLS handling< / td >
< / tr >
2018-04-27 00:09:55 +00:00
< / tbody >
< / table >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" >
< a href = "../nginx-configuration/log-format/" title = "Log format" class = "md-flex md-footer-nav__link md-footer-nav__link--prev" rel = "prev" >
< 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 >
Log format
< / span >
< / div >
< / a >
< a href = "../custom-errors/" title = "Custom errors" class = "md-flex md-footer-nav__link md-footer-nav__link--next" rel = "next" >
< 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 errors
< / 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 >
