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
< title > OpenTracing - NGINX Ingress Controller< / title >
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 = "#opentracing" 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" >
OpenTracing
< / 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" >
< 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" >
< 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--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 >
< 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
< 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 >
< 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" >
< a href = "../../cli-arguments/" title = "Command line arguments" class = "md-nav__link" >
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--active 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" checked >
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 = "../modsecurity/" title = "ModSecurity Web Application Firewall" class = "md-nav__link" >
ModSecurity Web Application Firewall
< / 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-24 15:16:34 +00:00
OpenTracing
< / label >
2018-04-27 00:09:55 +00:00
< a href = "./" title = "OpenTracing" class = "md-nav__link md-nav__link--active" >
OpenTracing
< / a >
2018-06-24 15:16:34 +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-24 15:16:34 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#usage" title = "Usage" class = "md-nav__link" >
Usage
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#examples" title = "Examples" class = "md-nav__link" >
Examples
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#zipkin" title = "Zipkin" class = "md-nav__link" >
Zipkin
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#jaeger" title = "Jaeger" class = "md-nav__link" >
Jaeger
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
2018-04-27 00:09:55 +00:00
< / 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-06-24 15:16:34 +00:00
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#usage" title = "Usage" class = "md-nav__link" >
Usage
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#examples" title = "Examples" class = "md-nav__link" >
Examples
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#zipkin" title = "Zipkin" class = "md-nav__link" >
Zipkin
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#jaeger" title = "Jaeger" class = "md-nav__link" >
Jaeger
< / a >
< / li >
< / ul >
< / nav >
< / 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/user-guide/third-party-addons/opentracing.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
< h1 id = "opentracing" > OpenTracing< a class = "headerlink" href = "#opentracing" title = "Permanent link" > ¶ < / a > < / h1 >
2019-02-12 00:47:17 +00:00
< p > Enables requests served by NGINX for distributed tracing via The OpenTracing Project.< / p >
2018-04-27 00:09:55 +00:00
< p > Using the third party module < a href = "https://github.com/opentracing-contrib/nginx-opentracing" > opentracing-contrib/nginx-opentracing< / a > the NGINX ingress controller can configure NGINX to enable < a href = "http://opentracing.io" > OpenTracing< / a > instrumentation.
By default this feature is disabled.< / p >
2018-06-24 15:16:34 +00:00
< h2 id = "usage" > Usage< a class = "headerlink" href = "#usage" title = "Permanent link" > ¶ < / a > < / h2 >
2019-02-12 00:47:17 +00:00
< p > To enable the instrumentation we must enable OpenTracing in the configuration ConfigMap:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "n" > data< / span > < span class = "o" > :< / span >
2018-06-24 15:16:34 +00:00
< span class = "n" > enable< / span > < span class = "o" > -< / span > < span class = "n" > opentracing< / span > < span class = "o" > :< / span > < span class = "s2" > " true" < / span >
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< p > We must also set the host to use when uploading traces:< / p >
2019-02-12 00:47:17 +00:00
< p > < div class = "codehilite" > < pre > < span > < / span > zipkin-collector-host: zipkin.default.svc.cluster.local
2019-02-20 19:05:39 +00:00
jaeger-collector-host: jaeger-agent.default.svc.cluster.local
2019-02-17 13:41:40 +00:00
datadog-collector-host: datadog-agent.default.svc.cluster.local
2018-06-24 15:16:34 +00:00
< / pre > < / div >
2019-02-12 00:47:17 +00:00
NOTE: While the option is called < code class = "codehilite" > jaeger-collector-host< / code > , you will need to point this to a < code class = "codehilite" > jaeger-agent< / code > , and not the < code class = "codehilite" > jaeger-collector< / code > component. < / p >
2019-02-17 13:41:40 +00:00
< p > Next you will need to deploy a distributed tracing system which uses OpenTracing.
< a href = "https://github.com/openzipkin/zipkin" > Zipkin< / a > and
< a href = "https://github.com/jaegertracing/jaeger" > Jaeger< / a > and
< a href = "https://github.com/DataDog/dd-opentracing-cpp" > Datadog< / a >
have been tested.< / p >
2018-09-04 23:47:40 +00:00
< p > Other optional configuration options:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > # specifies the port to use when uploading traces, Default: 9411
2018-06-24 15:16:34 +00:00
zipkin-collector-port
# specifies the service name to use for any traces created, Default: nginx
zipkin-service-name
2018-10-12 01:21:45 +00:00
# specifies sample rate for any traces created, Default: 1.0
2018-07-03 03:39:29 +00:00
zipkin-sample-rate
2018-10-12 01:21:45 +00:00
# specifies the port to use when uploading traces, Default: 6831
2018-06-24 15:16:34 +00:00
jaeger-collector-port
# specifies the service name to use for any traces created, Default: nginx
jaeger-service-name
# specifies the sampler to be used when sampling traces.
# The available samplers are: const, probabilistic, ratelimiting, remote, Default: const
jaeger-sampler-type
# specifies the argument to be passed to the sampler constructor, Default: 1
jaeger-sampler-param
2019-02-17 13:41:40 +00:00
# specifies the port to use when uploading traces, Default 8126
datadog-collector-port
# specifies the service name to use for any traces created, Default: nginx
datadog-service-name
# specifies the operation name to use for any traces collected, Default: nginx.handle
datadog-operation-name-override
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2019-02-12 00:47:17 +00:00
< p > All these options (including host) allow environment variables, such as < code class = "codehilite" > $HOSTNAME< / code > or < code class = "codehilite" > $HOST_IP< / code > . In the case of Jaeger, if you have a Jaeger agent running on each machine in your cluster, you can use something like < code class = "codehilite" > $HOST_IP< / code > (which can be 'mounted' with the < code class = "codehilite" > status.hostIP< / code > fieldpath, as described < a href = "https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#capabilities-of-the-downward-api" > here< / a > ) to make sure traces will be sent to the local agent.< / p >
2018-06-24 15:16:34 +00:00
< h2 id = "examples" > Examples< a class = "headerlink" href = "#examples" title = "Permanent link" > ¶ < / a > < / h2 >
< p > The following examples show how to deploy and test different distributed tracing systems. These example can be performed
using Minikube.< / p >
< h3 id = "zipkin" > Zipkin< a class = "headerlink" href = "#zipkin" title = "Permanent link" > ¶ < / a > < / h3 >
2018-04-27 00:09:55 +00:00
< p > In the < a href = "https://github.com/rnburn/zipkin-date-server" > rnburn/zipkin-date-server< / a >
2019-02-12 00:47:17 +00:00
GitHub repository is an example of a dockerized date service. To install the example and Zipkin collector run:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/master/kubernetes/zipkin.yaml
2018-04-27 00:09:55 +00:00
kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/master/kubernetes/deployment.yaml
< / pre > < / div >
2019-02-12 00:47:17 +00:00
< p > Also we need to configure the NGINX controller ConfigMap with the required values:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ < span class = "nb" > echo< / span > < span class = "s1" > ' < / span >
2018-04-27 00:09:55 +00:00
< span class = "s1" > apiVersion: v1< / span >
< span class = "s1" > kind: ConfigMap< / span >
< span class = "s1" > data:< / span >
< span class = "s1" > enable-opentracing: " true" < / span >
< span class = "s1" > zipkin-collector-host: zipkin.default.svc.cluster.local< / span >
< span class = "s1" > metadata:< / span >
2018-10-12 01:21:45 +00:00
< span class = "s1" > name: nginx-configuration< / span >
2018-06-24 15:16:34 +00:00
< span class = "s1" > namespace: kube-system< / span >
2018-04-27 00:09:55 +00:00
< span class = "s1" > ' < / span > < span class = "p" > |< / span > kubectl replace -f -
< / pre > < / div >
2019-02-12 00:47:17 +00:00
< p > In the Zipkin interface we can see the details:
2018-06-24 15:16:34 +00:00
< img alt = "zipkin screenshot" src = "../../../images/zipkin-demo.png" title = "zipkin collector screenshot" / > < / p >
< h3 id = "jaeger" > Jaeger< a class = "headerlink" href = "#jaeger" title = "Permanent link" > ¶ < / a > < / h3 >
< ol >
< li >
2019-02-12 00:47:17 +00:00
< p > Enable Ingress addon in Minikube:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ minikube addons < span class = "nb" > enable< / span > ingress
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
2019-02-12 00:47:17 +00:00
< p > Add Minikube IP to /etc/hosts:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ < span class = "nb" > echo< / span > < span class = "s2" > " < / span > < span class = "k" > $(< / span > minikube ip< span class = "k" > )< / span > < span class = "s2" > example.com" < / span > < span class = "p" > |< / span > sudo tee -a /etc/hosts
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
2019-02-12 00:47:17 +00:00
< p > Apply a basic Service and Ingress Resource:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > # Create Echoheaders Deployment
2018-09-04 23:47:40 +00:00
$ kubectl run echoheaders --image=k8s.gcr.io/echoserver:1.4 --replicas=1 --port=8080
# Expose as a Cluster-IP
$ kubectl expose deployment echoheaders --port=80 --target-port=8080 --name=echoheaders-x
# Apply the Ingress Resource
$ echo '
2018-06-24 15:16:34 +00:00
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: echo-ingress
spec:
rules:
- host: example.com
http:
paths:
- backend:
serviceName: echoheaders-x
servicePort: 80
path: /echo
2018-09-04 23:47:40 +00:00
' | kubectl apply -f -
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
2018-10-12 01:21:45 +00:00
< p > Enable OpenTracing and set the jaeger-collector-host:
< div class = "codehilite" > < pre > < span > < / span > $ < span class = "nb" > echo< / span > < span class = "s1" > ' < / span >
2018-09-04 23:47:40 +00:00
< span class = "s1" > apiVersion: v1< / span >
< span class = "s1" > kind: ConfigMap< / span >
< span class = "s1" > data:< / span >
< span class = "s1" > enable-opentracing: " true" < / span >
2019-02-20 19:05:39 +00:00
< span class = "s1" > jaeger-collector-host: jaeger-agent.default.svc.cluster.local< / span >
2018-09-04 23:47:40 +00:00
< span class = "s1" > metadata:< / span >
2018-10-12 01:21:45 +00:00
< span class = "s1" > name: nginx-configuration< / span >
2018-09-04 23:47:40 +00:00
< span class = "s1" > namespace: kube-system< / span >
< span class = "s1" > ' < / span > < span class = "p" > |< / span > kubectl replace -f -
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
< p > Apply the Jaeger All-In-One Template:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ kubectl apply -f https://raw.githubusercontent.com/jaegertracing/jaeger-kubernetes/master/all-in-one/jaeger-all-in-one-template.yml
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
< p > Make a few requests to the Service:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ curl example.com/echo -d < span class = "s2" > " meow" < / span >
2018-09-04 23:47:40 +00:00
CLIENT VALUES:
< span class = "nv" > client_address< / span > < span class = "o" > =< / span > < span class = "m" > 172< / span > .17.0.5
< span class = "nv" > command< / span > < span class = "o" > =< / span > POST
real < span class = "nv" > path< / span > < span class = "o" > =< / span > /echo
< span class = "nv" > query< / span > < span class = "o" > =< / span > nil
< span class = "nv" > request_version< / span > < span class = "o" > =< / span > < span class = "m" > 1< / span > .1
< span class = "nv" > request_uri< / span > < span class = "o" > =< / span > http://example.com:8080/echo
SERVER VALUES:
< span class = "nv" > server_version< / span > < span class = "o" > =< / span > nginx: < span class = "m" > 1< / span > .10.0 - lua: < span class = "m" > 10001< / span >
HEADERS RECEIVED:
< span class = "nv" > accept< / span > < span class = "o" > =< / span > */*
< span class = "nv" > connection< / span > < span class = "o" > =< / span > close
content-length< span class = "o" > =< / span > < span class = "m" > 4< / span >
content-type< span class = "o" > =< / span > application/x-www-form-urlencoded
< span class = "nv" > host< / span > < span class = "o" > =< / span > example.com
user-agent< span class = "o" > =< / span > curl/7.54.0
x-forwarded-for< span class = "o" > =< / span > < span class = "m" > 192< / span > .168.99.1
x-forwarded-host< span class = "o" > =< / span > example.com
x-forwarded-port< span class = "o" > =< / span > < span class = "m" > 80< / span >
x-forwarded-proto< span class = "o" > =< / span > http
x-original-uri< span class = "o" > =< / span > /echo
x-real-ip< span class = "o" > =< / span > < span class = "m" > 192< / span > .168.99.1
x-scheme< span class = "o" > =< / span > http
2018-06-24 15:16:34 +00:00
BODY:
meow
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2018-06-24 15:16:34 +00:00
< / li >
< li >
< p > View the Jaeger UI:
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > $ minikube service jaeger-query --url
2018-09-04 23:47:40 +00:00
http://192.168.99.100:30183
2018-10-12 01:21:45 +00:00
< / pre > < / div > < / p >
2019-02-12 00:47:17 +00:00
< p > In the Jaeger interface we can see the details:
2018-06-24 15:16:34 +00:00
< img alt = "jaeger screenshot" src = "../../../images/jaeger-demo.png" title = "jaeger collector screenshot" / > < / p >
< / li >
< / ol >
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" >
< a href = "../modsecurity/" title = "ModSecurity Web Application Firewall" 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 >
ModSecurity Web Application Firewall
< / span >
< / div >
< / a >
2018-09-13 23:54:10 +00:00
< a href = "../../../examples/" title = "Introduction" 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
Introduction
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 >
