{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview \u00b6 This is the documentation for the Ingress NGINX Controller. It is built around the Kubernetes Ingress resource , using a ConfigMap to store the controller configuration. You can learn more about using Ingress in the official Kubernetes documentation . Getting Started \u00b6 See Deployment for a whirlwind tour that will get you started. FAQ - Kubernetes 1.22 Migration \u00b6 If you are using Ingress objects in your cluster (running Kubernetes older than v1.22), and you plan to upgrade to Kubernetes v1.22, please read the migration guide here .","title":"Welcome"},{"location":"#overview","text":"This is the documentation for the Ingress NGINX Controller. It is built around the Kubernetes Ingress resource , using a ConfigMap to store the controller configuration. You can learn more about using Ingress in the official Kubernetes documentation .","title":"Overview"},{"location":"#getting-started","text":"See Deployment for a whirlwind tour that will get you started.","title":"Getting Started"},{"location":"#faq-kubernetes-122-migration","text":"If you are using Ingress objects in your cluster (running Kubernetes older than v1.22), and you plan to upgrade to Kubernetes v1.22, please read the migration guide here .","title":"FAQ - Kubernetes 1.22 Migration"},{"location":"e2e-tests/","text":"e2etestsuiteforIngressNGINXController\u00b6[Admission]admissioncontroller\u00b6rejectingresswithglobal-rate-limitannotationswhenmemcachedisnotconfiguredshouldnotallowoverlapsofhostandpathswithoutcanaryannotationsshouldallowoverlapsofhostandpathswithcanaryannotationshouldblockingresswithinvalidpathshouldreturnanerrorifthereisanerrorvalidatingtheingressdefinitionshouldreturnanerrorifthereisaninvalidvalueinsomeannotationshouldreturnanerrorifthereisaforbiddenvalueinsomeannotationshouldnotreturnanerroriftheIngressV1definitionisvalidwithIngressClassshouldnotreturnanerroriftheIngressV1definitionisvalidwithIngressClassannotationshouldreturnanerroriftheIngressV1definitioncontainsinvalidannotationsshouldnotreturnanerrorforaninvalidIngresswhenithasunknownclassaffinitymode\u00b6BalancedaffinitymodeshouldbalanceCheckpersistentaffinitymodeserver-alias\u00b6shouldreturnstatuscode200forhost'foo'and404for'bar'shouldreturnstatuscode200forhost'foo'and'bar'shouldreturnstatuscode200forhostsdefinedintwoingresses,differentpathwithonealiasapp-root\u00b6shouldredirectto/fooauth-tls-*\u00b6shouldsetsslClientCertificate,sslVerifyClientandsslVerifyDepthwithauth-tls-secretshouldsetvalidauth-tls-secret,sslVerifytooff,andsslVerifyDepthto2should302redirecttoerrorpageinsteadof400whenauth-tls-error-pageissetshouldpassURL-encodedcertificatetoupstreamshouldvalidateauth-tls-verify-clientshouldreturn403usingauth-tls-match-cnwithnomatchingCNfromclientshouldreturn200usingauth-tls-match-cnwithmatchingCNfromclientshouldreturn200usingauth-tls-match-cnwhereatleastoneoftheregexoptionsmatchesCNfromclientbackend-protocol\u00b6shouldsetbackendprotocoltohttps:// and use proxy_pass should set backend protocol to $scheme:// and use proxy_pass should set backend protocol to grpc:// and use grpc_pass should set backend protocol to grpcs:// and use grpc_pass should set backend protocol to '' and use fastcgi_pass should set backend protocol to '' and use ajp_pass client-body-buffer-size \u00b6 should set client_body_buffer_size to 1000 should set client_body_buffer_size to 1K should set client_body_buffer_size to 1k should set client_body_buffer_size to 1m should set client_body_buffer_size to 1M should not set client_body_buffer_size to invalid 1b connection-proxy-header \u00b6 set connection header to keep-alive cors-* \u00b6 should enable cors should set cors methods to