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 > Installation Guide - 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 = "#installation-guide" 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" >
Installation Guide
< / 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 = "./" title = "Deployment" class = "md-tabs__link md-tabs__link--active" >
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" >
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--active md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-2" type = "checkbox" id = "nav-2" checked >
< 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 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-04-27 00:09:55 +00:00
Installation Guide
< / label >
< a href = "./" title = "Installation Guide" class = "md-nav__link md-nav__link--active" >
Installation Guide
< / a >
< 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 = "#contents" title = "Contents" class = "md-nav__link" >
Contents
< / a >
< / li >
< li class = "md-nav__item" >
2018-10-15 22:13:41 +00:00
< a href = "#prerequisite-generic-deployment-command" title = "Prerequisite Generic Deployment Command" class = "md-nav__link" >
Prerequisite Generic Deployment Command
2018-04-27 00:09:55 +00:00
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#provider-specific-steps" title = "Provider Specific Steps" class = "md-nav__link" >
Provider Specific Steps
2018-04-27 00:09:55 +00:00
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#docker-for-mac" title = "Docker for Mac" class = "md-nav__link" >
Docker for Mac
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#minikube" title = "minikube" class = "md-nav__link" >
minikube
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#aws" title = "AWS" class = "md-nav__link" >
AWS
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#elastic-load-balancer-elb" title = "Elastic Load Balancer - ELB" class = "md-nav__link" >
Elastic Load Balancer - ELB
< / a >
2018-09-06 14:08:47 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#elb-idle-timeouts" title = "ELB Idle Timeouts" class = "md-nav__link" >
ELB Idle Timeouts
< / a >
2018-04-27 00:09:55 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#network-load-balancer-nlb" title = "Network Load Balancer (NLB)" class = "md-nav__link" >
Network Load Balancer (NLB)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2019-03-10 14:19:54 +00:00
< a href = "#gce-gke" title = "GCE-GKE" class = "md-nav__link" >
GCE-GKE
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#azure" title = "Azure" class = "md-nav__link" >
Azure
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-04 23:47:40 +00:00
< a href = "#bare-metal" title = "Bare-metal" class = "md-nav__link" >
Bare-metal
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#verify-installation" title = "Verify installation" class = "md-nav__link" >
Verify installation
2018-04-27 00:09:55 +00:00
< / a >
< / li >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#detect-installed-version" title = "Detect installed version" class = "md-nav__link" >
Detect installed version
2018-04-27 00:09:55 +00:00
< / a >
2018-07-05 14:29:15 +00:00
< / li >
< / ul >
< / nav >
2018-04-27 00:09:55 +00:00
< / li >
< li class = "md-nav__item" >
2018-07-05 14:29:15 +00:00
< a href = "#using-helm" title = "Using Helm" class = "md-nav__link" >
Using Helm
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
2018-09-04 23:47:40 +00:00
< li class = "md-nav__item" >
< a href = "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 = "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 = "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 = "upgrade/" title = "Upgrade" class = "md-nav__link" >
Upgrade
2018-05-03 14:08:21 +00:00
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3" type = "checkbox" id = "nav-3" >
< label class = "md-nav__link" for = "nav-3" >
User guide
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-3" >
User guide
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "nav-3-1" type = "checkbox" id = "nav-3-1" >
< label class = "md-nav__link" for = "nav-3-1" >
NGINX Configuration
< / label >
< nav class = "md-nav" data-md-component = "collapsible" data-md-level = "2" >
< label class = "md-nav__title" for = "nav-3-1" >
NGINX Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2018-09-13 23:54:10 +00:00
< a href = "../user-guide/nginx-configuration/" title = "Introduction" class = "md-nav__link" >
Introduction
2018-04-27 00:09:55 +00:00
< / a >
< / li >
2019-03-08 00:36:59 +00:00
< li class = "md-nav__item" >
< a href = "../user-guide/basic-usage/" title = "Basic usage" class = "md-nav__link" >
Basic usage
< / a >
< / li >
2018-04-27 00:09:55 +00:00
< li class = "md-nav__item" >
< 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 = "#contents" title = "Contents" class = "md-nav__link" >
Contents
< / a >
< / li >
< li class = "md-nav__item" >
2018-10-15 22:13:41 +00:00
< a href = "#prerequisite-generic-deployment-command" title = "Prerequisite Generic Deployment Command" class = "md-nav__link" >
Prerequisite Generic Deployment Command
2018-04-27 00:09:55 +00:00
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#provider-specific-steps" title = "Provider Specific Steps" class = "md-nav__link" >
Provider Specific Steps
2018-04-27 00:09:55 +00:00
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#docker-for-mac" title = "Docker for Mac" class = "md-nav__link" >
Docker for Mac
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#minikube" title = "minikube" class = "md-nav__link" >
minikube
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#aws" title = "AWS" class = "md-nav__link" >
AWS
< / a >
< nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#elastic-load-balancer-elb" title = "Elastic Load Balancer - ELB" class = "md-nav__link" >
Elastic Load Balancer - ELB
< / a >
2018-09-06 14:08:47 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#elb-idle-timeouts" title = "ELB Idle Timeouts" class = "md-nav__link" >
ELB Idle Timeouts
< / a >
2018-04-27 00:09:55 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#network-load-balancer-nlb" title = "Network Load Balancer (NLB)" class = "md-nav__link" >
Network Load Balancer (NLB)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2019-03-10 14:19:54 +00:00
< a href = "#gce-gke" title = "GCE-GKE" class = "md-nav__link" >
GCE-GKE
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#azure" title = "Azure" class = "md-nav__link" >
Azure
< / a >
< / li >
< li class = "md-nav__item" >
2018-09-04 23:47:40 +00:00
< a href = "#bare-metal" title = "Bare-metal" class = "md-nav__link" >
Bare-metal
2018-04-27 00:09:55 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#verify-installation" title = "Verify installation" class = "md-nav__link" >
Verify installation
2018-04-27 00:09:55 +00:00
< / a >
< / li >
2018-07-05 14:29:15 +00:00
< li class = "md-nav__item" >
< a href = "#detect-installed-version" title = "Detect installed version" class = "md-nav__link" >
Detect installed version
2018-04-27 00:09:55 +00:00
< / a >
2018-07-05 14:29:15 +00:00
< / li >
< / ul >
< / nav >
2018-04-27 00:09:55 +00:00
< / li >
< li class = "md-nav__item" >
2018-07-05 14:29:15 +00:00
< a href = "#using-helm" title = "Using Helm" class = "md-nav__link" >
Using Helm
2018-04-27 00:09:55 +00:00
< / 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/deploy/index.md" title = "Edit this page" class = "md-icon md-content__icon" >  < / a >
< h1 id = "installation-guide" > Installation Guide< a class = "headerlink" href = "#installation-guide" title = "Permanent link" > ¶ < / a > < / h1 >
< h2 id = "contents" > Contents< a class = "headerlink" href = "#contents" title = "Permanent link" > ¶ < / a > < / h2 >
< ul >
2018-10-29 13:54:18 +00:00
< li > < a href = "#prerequisite-generic-deployment-command" > Prerequisite Generic Deployment Command< / a > < / li >
2018-07-05 14:29:15 +00:00
< li > < a href = "#provider-specific-steps" > Provider Specific Steps< / a > < ul >
2018-04-27 00:09:55 +00:00
< li > < a href = "#docker-for-mac" > Docker for Mac< / a > < / li >
< li > < a href = "#minikube" > minikube< / a > < / li >
< li > < a href = "#aws" > AWS< / a > < / li >
2018-08-22 19:35:46 +00:00
< li > < a href = "#gce-gke" > GCE - GKE< / a > < / li >
2018-04-27 00:09:55 +00:00
< li > < a href = "#azure" > Azure< / a > < / li >
2018-09-04 23:47:40 +00:00
< li > < a href = "#bare-metal" > Bare-metal< / a > < / li >
2018-07-05 14:29:15 +00:00
< / ul >
< / li >
2018-04-27 00:09:55 +00:00
< li > < a href = "#verify-installation" > Verify installation< / a > < / li >
< li > < a href = "#detect-installed-version" > Detect installed version< / a > < / li >
2018-07-05 14:29:15 +00:00
< li > < a href = "#using-helm" > Using Helm< / a > < / li >
2018-04-27 00:09:55 +00:00
< / ul >
2018-10-15 22:13:41 +00:00
< h2 id = "prerequisite-generic-deployment-command" > Prerequisite Generic Deployment Command< a class = "headerlink" href = "#prerequisite-generic-deployment-command" title = "Permanent link" > ¶ < / a > < / h2 >
2019-05-26 08:06:36 +00:00
< div class = "admonition attention" >
< p class = "admonition-title" > Attention< / p >
2019-06-05 15:04:55 +00:00
< p > The default configuration watches Ingress object from < em > all the namespaces< / em > .
2018-09-13 14:29:31 +00:00
To change this behavior use the flag < code class = "codehilite" > --watch-namespace< / code > to limit the scope to a particular namespace.< / p >
< / div >
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.< / p >
< / div >
2019-06-05 15:04:55 +00:00
< div class = "admonition attention" >
< p class = "admonition-title" > Attention< / p >
< p > If you're using GKE you need to initialize your user as a cluster-admin with the following command:
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl create clusterrolebinding cluster-admin-binding \< / span >
< span class = "go" > --clusterrole cluster-admin \< / span >
< span class = "go" > --user $(gcloud config get-value account)< / span >
< / pre > < / div > < / p >
< / div >
< p > The following < strong > Mandatory Command< / strong > is required for all deployments.< / p >
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/mandatory.yaml< / span >
2018-10-15 22:13:41 +00:00
< / pre > < / div >
2018-07-05 14:29:15 +00:00
< h3 id = "provider-specific-steps" > Provider Specific Steps< a class = "headerlink" href = "#provider-specific-steps" title = "Permanent link" > ¶ < / a > < / h3 >
2019-06-05 15:04:55 +00:00
< p > There are cloud provider specific yaml files.< / p >
2018-07-05 14:29:15 +00:00
< h4 id = "docker-for-mac" > Docker for Mac< a class = "headerlink" href = "#docker-for-mac" title = "Permanent link" > ¶ < / a > < / h4 >
2018-07-28 15:21:37 +00:00
< p > Kubernetes is available in Docker for Mac (from < a href = "https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018" > version 18.06.0-ce< / a > )< / p >
2019-06-05 15:04:55 +00:00
< p > Create a service< / p >
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud-generic.yaml< / span >
< / pre > < / div >
2018-07-05 14:29:15 +00:00
< h4 id = "minikube" > minikube< a class = "headerlink" href = "#minikube" title = "Permanent link" > ¶ < / a > < / h4 >
2018-04-27 00:09:55 +00:00
< p > For standard usage:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > minikube addons enable ingress< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< p > For development:< / p >
< ol >
< li > Disable the ingress addon:< / li >
< / ol >
2019-06-05 15:04:55 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > minikube addons disable ingress< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< ol >
2018-05-17 22:27:33 +00:00
< li > Execute < code class = "codehilite" > make dev-env< / code > < / li >
2018-04-27 00:09:55 +00:00
< li > Confirm the < code class = "codehilite" > nginx-ingress-controller< / code > deployment exists:< / li >
< / ol >
2019-06-05 15:04:55 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "gp" > $< / span > kubectl get pods -n ingress-nginx
2018-04-27 00:09:55 +00:00
< span class = "go" > NAME READY STATUS RESTARTS AGE< / span >
< span class = "go" > default-http-backend-66b447d9cf-rrlf9 1/1 Running 0 12s< / span >
< span class = "go" > nginx-ingress-controller-fdcdcd6dd-vvpgs 1/1 Running 0 11s< / span >
< / pre > < / div >
2018-07-05 14:29:15 +00:00
< h4 id = "aws" > AWS< a class = "headerlink" href = "#aws" title = "Permanent link" > ¶ < / a > < / h4 >
2018-04-27 00:09:55 +00:00
< p > In AWS we use an Elastic Load Balancer (ELB) to expose the NGINX Ingress controller behind a Service of < code class = "codehilite" > Type=LoadBalancer< / code > .
Since Kubernetes v1.9.0 it is possible to use a classic load balancer (ELB) or network load balancer (NLB)
2018-09-20 21:17:55 +00:00
Please check the < a href = "https://aws.amazon.com/elasticloadbalancing/details/" > elastic load balancing AWS details page< / a > < / p >
2018-07-05 14:29:15 +00:00
< h5 id = "elastic-load-balancer-elb" > Elastic Load Balancer - ELB< a class = "headerlink" href = "#elastic-load-balancer-elb" title = "Permanent link" > ¶ < / a > < / h5 >
2018-04-27 00:09:55 +00:00
< p > This setup requires to choose in which layer (L4 or L7) we want to configure the ELB:< / p >
< ul >
< li > < a href = "https://en.wikipedia.org/wiki/OSI_model#Layer_4:_Transport_Layer" > Layer 4< / a > : use TCP as the listener protocol for ports 80 and 443.< / li >
< li > < a href = "https://en.wikipedia.org/wiki/OSI_model#Layer_7:_Application_Layer" > Layer 7< / a > : use HTTP as the listener protocol for port 80 and terminate TLS in the ELB< / li >
< / ul >
2019-05-26 08:06:36 +00:00
< p > For L4:< / p >
2019-06-05 15:04:55 +00:00
< p > Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the < a href = "#elb-idle-timeouts" > ELB Idle Timeouts section< / a > for additional information. If a change is required, users will need to update the value of < code class = "codehilite" > service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout< / code > in < code class = "codehilite" > provider/aws/service-l4.yaml< / code > < / p >
< p > Then execute:< / p >
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/service-l4.yaml< / span >
< span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/patch-configmap-l4.yaml< / span >
2019-05-26 08:06:36 +00:00
< / pre > < / div >
2019-06-05 15:04:55 +00:00
< p > For L7:< / p >
< p > Change line of the file < code class = "codehilite" > provider/aws/service-l7.yaml< / code > replacing the dummy id with a valid one < code class = "codehilite" > " arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX" < / code > < / p >
< p > Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the < a href = "#elb-idle-timeouts" > ELB Idle Timeouts section< / a > for additional information. If a change is required, users will need to update the value of < code class = "codehilite" > service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout< / code > in < code class = "codehilite" > provider/aws/service-l7.yaml< / code > < / p >
< p > Then execute:< / p >
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/service-l7.yaml< / span >
< span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/patch-configmap-l7.yaml< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< p > This example creates an ELB with just two listeners, one in port 80 and another in port 443< / p >
2018-09-13 23:54:10 +00:00
< p > < img alt = "Listeners" src = "../images/elb-l7-listener.png" / > < / p >
2018-09-06 14:08:47 +00:00
< h5 id = "elb-idle-timeouts" > ELB Idle Timeouts< a class = "headerlink" href = "#elb-idle-timeouts" title = "Permanent link" > ¶ < / a > < / h5 >
< p > In some scenarios users will need to modify the value of the ELB idle timeout. Users need to ensure the idle timeout is less than the < a href = "http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout" > keepalive_timeout< / a > that is configured for NGINX. By default NGINX < code class = "codehilite" > keepalive_timeout< / code > is set to < code class = "codehilite" > 75s< / code > .< / p >
< p > The default ELB idle timeout will work for most scenarios, unless the NGINX < a href = "http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout" > keepalive_timeout< / a > has been modified, in which case < code class = "codehilite" > service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout< / code > will need to be modified to ensure it is less than the < code class = "codehilite" > keepalive_timeout< / code > the user has configured.< / p >
< p > < em > Please Note: An idle timeout of < code class = "codehilite" > 3600s< / code > is recommended when using WebSockets.< / em > < / p >
< p > More information with regards to idle timeouts for your Load Balancer can be found in the < a href = "https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html" > official AWS documentation< / a > .< / p >
2018-07-05 14:29:15 +00:00
< h5 id = "network-load-balancer-nlb" > Network Load Balancer (NLB)< a class = "headerlink" href = "#network-load-balancer-nlb" title = "Permanent link" > ¶ < / a > < / h5 >
2019-06-05 15:04:55 +00:00
< p > This type of load balancer is supported since v1.10.0 as an ALPHA feature.< / p >
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/service-nlb.yaml< / span >
< / pre > < / div >
2019-03-10 14:19:54 +00:00
< h4 id = "gce-gke" > GCE-GKE< a class = "headerlink" href = "#gce-gke" title = "Permanent link" > ¶ < / a > < / h4 >
2019-06-05 15:04:55 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud-generic.yaml< / span >
< / pre > < / div >
2018-04-27 00:09:55 +00:00
< p > < strong > Important Note:< / strong > proxy protocol is not supported in GCE/GKE< / p >
2018-07-05 14:29:15 +00:00
< h4 id = "azure" > Azure< a class = "headerlink" href = "#azure" title = "Permanent link" > ¶ < / a > < / h4 >
2019-06-05 15:04:55 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud-generic.yaml< / span >
< / pre > < / div >
2018-09-04 23:47:40 +00:00
< h4 id = "bare-metal" > Bare-metal< a class = "headerlink" href = "#bare-metal" title = "Permanent link" > ¶ < / a > < / h4 >
2018-04-27 00:09:55 +00:00
< p > Using < a href = "https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport" > NodePort< / a > :< / p >
2019-06-05 15:04:55 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/baremetal/service-nodeport.yaml< / span >
< / pre > < / div >
2018-09-04 23:47:40 +00:00
< div class = "admonition tip" >
< p class = "admonition-title" > Tip< / p >
2018-11-22 02:35:18 +00:00
< p > For extended notes regarding deployments on bare-metal, see < a href = "baremetal/" > Bare-metal considerations< / a > .< / p >
2018-09-04 23:47:40 +00:00
< / div >
2018-07-05 14:29:15 +00:00
< h3 id = "verify-installation" > Verify installation< a class = "headerlink" href = "#verify-installation" title = "Permanent link" > ¶ < / a > < / h3 >
< p > To check if the ingress controller pods have started, run the following command:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > kubectl get pods --all-namespaces -l app.kubernetes.io/name=ingress-nginx --watch< / span >
2018-07-05 14:29:15 +00:00
< / pre > < / div >
< p > Once the operator pods are running, you can cancel the above command by typing < code class = "codehilite" > Ctrl+C< / code > .
Now, you are ready to create your first ingress.< / p >
< h3 id = "detect-installed-version" > Detect installed version< a class = "headerlink" href = "#detect-installed-version" title = "Permanent link" > ¶ < / a > < / h3 >
< p > To detect which version of the ingress controller is running, exec into the pod and run < code class = "codehilite" > nginx-ingress-controller version< / code > command.< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > POD_NAMESPACE=ingress-nginx< / span >
2018-09-05 12:51:21 +00:00
< span class = "go" > POD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app.kubernetes.io/name=ingress-nginx -o jsonpath=' {.items[0].metadata.name}' )< / span >
2019-06-05 15:04:55 +00:00
2018-07-05 14:29:15 +00:00
< span class = "go" > kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version< / span >
< / pre > < / div >
2018-04-27 00:09:55 +00:00
< h2 id = "using-helm" > Using Helm< a class = "headerlink" href = "#using-helm" title = "Permanent link" > ¶ < / a > < / h2 >
2019-06-05 15:04:55 +00:00
< p > NGINX Ingress controller can be installed via < a href = "https://helm.sh/" > Helm< / a > using the chart < a href = "https://github.com/kubernetes/charts/tree/master/stable/nginx-ingress" > stable/nginx-ingress< / a > from the official charts repository.
2018-04-27 00:09:55 +00:00
To install the chart with the release name < code class = "codehilite" > my-nginx< / code > :< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > helm install stable/nginx-ingress --name my-nginx< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< p > If the kubernetes cluster has RBAC enabled, then run:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > helm install stable/nginx-ingress --name my-nginx --set rbac.create=true< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
2018-07-05 14:29:15 +00:00
< p > Detect installed version:< / p >
2018-10-12 01:21:45 +00:00
< div class = "codehilite" > < pre > < span > < / span > < span class = "go" > POD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath=' {.items[0].metadata.name}' )< / span >
2018-07-05 14:29:15 +00:00
< span class = "go" > kubectl exec -it $POD_NAME -- /nginx-ingress-controller --version< / span >
2018-04-27 00:09:55 +00:00
< / pre > < / div >
< / 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 = "../development/" title = "Development" 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
Development
2018-04-27 00:09:55 +00:00
< / span >
< / div >
< / a >
2018-09-04 23:47:40 +00:00
< a href = "baremetal/" title = "Bare-metal considerations" 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-04 23:47:40 +00:00
Bare-metal considerations
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 >
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 >
