From b3d5b69555c2dfa3ad351e3b3619f92dafa077fe Mon Sep 17 00:00:00 2001 From: Travis Bot Date: Thu, 13 Sep 2018 14:29:31 +0000 Subject: [PATCH] Deploy GitHub Pages --- deploy/index.html | 9 ++++ search/search_index.json | 4 +- sitemap.xml | 90 ++++++++++++++++++++-------------------- 3 files changed, 56 insertions(+), 47 deletions(-) diff --git a/deploy/index.html b/deploy/index.html index 717feaedc..0ce5aae3b 100644 --- a/deploy/index.html +++ b/deploy/index.html @@ -1374,6 +1374,15 @@ 
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml
+
+

Attention

+

The default configuration watches Ingress object from all the namespaces. +To change this behavior use the flag --watch-namespace to limit the scope to a particular namespace.

+
+
+

Warning

+

If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.

+

Provider Specific Steps

There are cloud provider specific yaml files.

Docker for Mac

diff --git a/search/search_index.json b/search/search_index.json index 476f6cecc..fe60f1fdb 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -17,7 +17,7 @@ }, { "location": "/deploy/", - "text": "Installation Guide\n\u00b6\n\n\nContents\n\u00b6\n\n\n\n\nGeneric Deployment\n\n\nMandatory command\n\n\nProvider Specific Steps\n\n\nDocker for Mac\n\n\nminikube\n\n\nAWS\n\n\nGCE - GKE\n\n\nAzure\n\n\nBare-metal\n\n\n\n\n\n\nVerify installation\n\n\nDetect installed version\n\n\nUsing Helm\n\n\n\n\nGeneric Deployment\n\u00b6\n\n\nThe following resources are required for a generic deployment.\n\n\nMandatory command\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml\n\n\n\n\n\nProvider Specific Steps\n\u00b6\n\n\nThere are cloud provider specific yaml files.\n\n\nDocker for Mac\n\u00b6\n\n\nKubernetes is available in Docker for Mac (from \nversion 18.06.0-ce\n)\n\n\nCreate a service\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nminikube\n\u00b6\n\n\nFor standard usage:\n\n\nminikube addons enable ingress\n\n\n\n\n\nFor development:\n\n\n\n\nDisable the ingress addon:\n\n\n\n\n$\n minikube addons disable ingress\n\n\n\n\n\n\nExecute \nmake dev-env\n\n\nConfirm the \nnginx-ingress-controller\n deployment exists:\n\n\n\n\n$\n kubectl get pods -n ingress-nginx \n\nNAME READY STATUS RESTARTS AGE\n\n\ndefault-http-backend-66b447d9cf-rrlf9 1/1 Running 0 12s\n\n\nnginx-ingress-controller-fdcdcd6dd-vvpgs 1/1 Running 0 11s\n\n\n\n\n\nAWS\n\u00b6\n\n\nIn AWS we use an Elastic Load Balancer (ELB) to expose the NGINX Ingress controller behind a Service of \nType=LoadBalancer\n.\nSince Kubernetes v1.9.0 it is possible to use a classic load balancer (ELB) or network load balancer (NLB)\nPlease check the \nelastic load balancing AWS details page\n\n\nElastic Load Balancer - ELB\n\u00b6\n\n\nThis setup requires to choose in which layer (L4 or L7) we want to configure the ELB:\n\n\n\n\nLayer 4\n: use TCP as the listener protocol for ports 80 and 443.\n\n\nLayer 7\n: use HTTP as the listener protocol for port 80 and terminate TLS in the ELB\n\n\n\n\nFor L4:\n\n\nCheck 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 \nELB Idle Timeouts section\n for additional information. If a change is required, users will need to update the value of \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n in \nprovider/aws/service-l4.yaml\n\n\nThen execute:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l4.yaml\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l4.yaml\n\n\n\n\n\nFor L7:\n\n\nChange line of the file \nprovider/aws/service-l7.yaml\n replacing the dummy id with a valid one \n\"arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX\"\n\n\nCheck 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 \nELB Idle Timeouts section\n for additional information. If a change is required, users will need to update the value of \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n in \nprovider/aws/service-l7.yaml\n\n\nThen execute:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l7.yaml\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l7.yaml\n\n\n\n\n\nThis example creates an ELB with just two listeners, one in port 80 and another in port 443\n\n\n\n\nELB Idle Timeouts\n\u00b6\n\n\nIn 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 \nkeepalive_timeout\n that is configured for NGINX. By default NGINX \nkeepalive_timeout\n is set to \n75s\n.\n\n\nThe default ELB idle timeout will work for most scenarios, unless the NGINX \nkeepalive_timeout\n has been modified, in which case \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n will need to be modified to ensure it is less than the \nkeepalive_timeout\n the user has configured.\n\n\nPlease Note: An idle timeout of \n3600s\n is recommended when using WebSockets.\n\n\nMore information with regards to idle timeouts for your Load Balancer can be found in the \nofficial AWS documentation\n.\n\n\nNetwork Load Balancer (NLB)\n\u00b6\n\n\nThis type of load balancer is supported since v1.10.0 as an ALPHA feature.\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-nlb.yaml\n\n\n\n\n\nGCE - GKE\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nImportant Note:\n proxy protocol is not supported in GCE/GKE\n\n\nAzure\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nBare-metal\n\u00b6\n\n\nUsing \nNodePort\n:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/baremetal/service-nodeport.yaml\n\n\n\n\n\n\n\nTip\n\n\nFor extended notes regarding deployments on bare-metal, see \nBare-metal considerations\n.\n\n\n\n\nVerify installation\n\u00b6\n\n\nTo check if the ingress controller pods have started, run the following command:\n\n\nkubectl get pods --all-namespaces -l app.kubernetes.io/name=ingress-nginx --watch\n\n\n\n\n\nOnce the operator pods are running, you can cancel the above command by typing \nCtrl+C\n.\nNow, you are ready to create your first ingress.\n\n\nDetect installed version\n\u00b6\n\n\nTo detect which version of the ingress controller is running, exec into the pod and run \nnginx-ingress-controller version\n command.\n\n\nPOD_NAMESPACE=ingress-nginx\n\n\nPOD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')\n\n\nkubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version\n\n\n\n\n\nUsing Helm\n\u00b6\n\n\nNGINX Ingress controller can be installed via \nHelm\n using the chart \nstable/nginx-ingress\n from the official charts repository. \nTo install the chart with the release name \nmy-nginx\n:\n\n\nhelm install stable/nginx-ingress --name my-nginx\n\n\n\n\n\nIf the kubernetes cluster has RBAC enabled, then run:\n\n\nhelm install stable/nginx-ingress --name my-nginx --set rbac.create=true\n\n\n\n\n\nDetect installed version:\n\n\nPOD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')\n\n\nkubectl exec -it $POD_NAME -- /nginx-ingress-controller --version", + "text": "Installation Guide\n\u00b6\n\n\nContents\n\u00b6\n\n\n\n\nGeneric Deployment\n\n\nMandatory command\n\n\nProvider Specific Steps\n\n\nDocker for Mac\n\n\nminikube\n\n\nAWS\n\n\nGCE - GKE\n\n\nAzure\n\n\nBare-metal\n\n\n\n\n\n\nVerify installation\n\n\nDetect installed version\n\n\nUsing Helm\n\n\n\n\nGeneric Deployment\n\u00b6\n\n\nThe following resources are required for a generic deployment.\n\n\nMandatory command\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml\n\n\n\n\n\n\n\nAttention\n\n\nThe default configuration watches Ingress object from all the namespaces.\nTo change this behavior use the flag \n--watch-namespace\n to limit the scope to a particular namespace.\n\n\n\n\n\n\nWarning\n\n\nIf multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.\n\n\n\n\nProvider Specific Steps\n\u00b6\n\n\nThere are cloud provider specific yaml files.\n\n\nDocker for Mac\n\u00b6\n\n\nKubernetes is available in Docker for Mac (from \nversion 18.06.0-ce\n)\n\n\nCreate a service\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nminikube\n\u00b6\n\n\nFor standard usage:\n\n\nminikube addons enable ingress\n\n\n\n\n\nFor development:\n\n\n\n\nDisable the ingress addon:\n\n\n\n\n$\n minikube addons disable ingress\n\n\n\n\n\n\nExecute \nmake dev-env\n\n\nConfirm the \nnginx-ingress-controller\n deployment exists:\n\n\n\n\n$\n kubectl get pods -n ingress-nginx \n\nNAME READY STATUS RESTARTS AGE\n\n\ndefault-http-backend-66b447d9cf-rrlf9 1/1 Running 0 12s\n\n\nnginx-ingress-controller-fdcdcd6dd-vvpgs 1/1 Running 0 11s\n\n\n\n\n\nAWS\n\u00b6\n\n\nIn AWS we use an Elastic Load Balancer (ELB) to expose the NGINX Ingress controller behind a Service of \nType=LoadBalancer\n.\nSince Kubernetes v1.9.0 it is possible to use a classic load balancer (ELB) or network load balancer (NLB)\nPlease check the \nelastic load balancing AWS details page\n\n\nElastic Load Balancer - ELB\n\u00b6\n\n\nThis setup requires to choose in which layer (L4 or L7) we want to configure the ELB:\n\n\n\n\nLayer 4\n: use TCP as the listener protocol for ports 80 and 443.\n\n\nLayer 7\n: use HTTP as the listener protocol for port 80 and terminate TLS in the ELB\n\n\n\n\nFor L4:\n\n\nCheck 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 \nELB Idle Timeouts section\n for additional information. If a change is required, users will need to update the value of \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n in \nprovider/aws/service-l4.yaml\n\n\nThen execute:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l4.yaml\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l4.yaml\n\n\n\n\n\nFor L7:\n\n\nChange line of the file \nprovider/aws/service-l7.yaml\n replacing the dummy id with a valid one \n\"arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX\"\n\n\nCheck 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 \nELB Idle Timeouts section\n for additional information. If a change is required, users will need to update the value of \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n in \nprovider/aws/service-l7.yaml\n\n\nThen execute:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l7.yaml\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l7.yaml\n\n\n\n\n\nThis example creates an ELB with just two listeners, one in port 80 and another in port 443\n\n\n\n\nELB Idle Timeouts\n\u00b6\n\n\nIn 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 \nkeepalive_timeout\n that is configured for NGINX. By default NGINX \nkeepalive_timeout\n is set to \n75s\n.\n\n\nThe default ELB idle timeout will work for most scenarios, unless the NGINX \nkeepalive_timeout\n has been modified, in which case \nservice.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout\n will need to be modified to ensure it is less than the \nkeepalive_timeout\n the user has configured.\n\n\nPlease Note: An idle timeout of \n3600s\n is recommended when using WebSockets.\n\n\nMore information with regards to idle timeouts for your Load Balancer can be found in the \nofficial AWS documentation\n.\n\n\nNetwork Load Balancer (NLB)\n\u00b6\n\n\nThis type of load balancer is supported since v1.10.0 as an ALPHA feature.\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-nlb.yaml\n\n\n\n\n\nGCE - GKE\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nImportant Note:\n proxy protocol is not supported in GCE/GKE\n\n\nAzure\n\u00b6\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml\n\n\n\n\n\nBare-metal\n\u00b6\n\n\nUsing \nNodePort\n:\n\n\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/baremetal/service-nodeport.yaml\n\n\n\n\n\n\n\nTip\n\n\nFor extended notes regarding deployments on bare-metal, see \nBare-metal considerations\n.\n\n\n\n\nVerify installation\n\u00b6\n\n\nTo check if the ingress controller pods have started, run the following command:\n\n\nkubectl get pods --all-namespaces -l app.kubernetes.io/name=ingress-nginx --watch\n\n\n\n\n\nOnce the operator pods are running, you can cancel the above command by typing \nCtrl+C\n.\nNow, you are ready to create your first ingress.\n\n\nDetect installed version\n\u00b6\n\n\nTo detect which version of the ingress controller is running, exec into the pod and run \nnginx-ingress-controller version\n command.\n\n\nPOD_NAMESPACE=ingress-nginx\n\n\nPOD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')\n\n\nkubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version\n\n\n\n\n\nUsing Helm\n\u00b6\n\n\nNGINX Ingress controller can be installed via \nHelm\n using the chart \nstable/nginx-ingress\n from the official charts repository. \nTo install the chart with the release name \nmy-nginx\n:\n\n\nhelm install stable/nginx-ingress --name my-nginx\n\n\n\n\n\nIf the kubernetes cluster has RBAC enabled, then run:\n\n\nhelm install stable/nginx-ingress --name my-nginx --set rbac.create=true\n\n\n\n\n\nDetect installed version:\n\n\nPOD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')\n\n\nkubectl exec -it $POD_NAME -- /nginx-ingress-controller --version", "title": "Installation Guide" }, { @@ -37,7 +37,7 @@ }, { "location": "/deploy/#mandatory-command", - "text": "kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml", + "text": "kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml Attention The default configuration watches Ingress object from all the namespaces.\nTo change this behavior use the flag --watch-namespace to limit the scope to a particular namespace. Warning If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.", "title": "Mandatory command" }, { diff --git a/sitemap.xml b/sitemap.xml index 008dd2059..22b0f169b 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,227 +2,227 @@ / - 2018-09-12 + 2018-09-13 daily /deploy/ - 2018-09-12 + 2018-09-13 daily /deploy/baremetal/ - 2018-09-12 + 2018-09-13 daily /deploy/rbac/ - 2018-09-12 + 2018-09-13 daily /deploy/upgrade/ - 2018-09-12 + 2018-09-13 daily /user-guide/nginx-configuration/ - 2018-09-12 + 2018-09-13 daily /user-guide/nginx-configuration/annotations/ - 2018-09-12 + 2018-09-13 daily /user-guide/nginx-configuration/configmap/ - 2018-09-12 + 2018-09-13 daily /user-guide/nginx-configuration/custom-template/ - 2018-09-12 + 2018-09-13 daily /user-guide/nginx-configuration/log-format/ - 2018-09-12 + 2018-09-13 daily /user-guide/cli-arguments/ - 2018-09-12 + 2018-09-13 daily /user-guide/custom-errors/ - 2018-09-12 + 2018-09-13 daily /user-guide/default-backend/ - 2018-09-12 + 2018-09-13 daily /user-guide/exposing-tcp-udp-services/ - 2018-09-12 + 2018-09-13 daily /user-guide/external-articles/ - 2018-09-12 + 2018-09-13 daily /user-guide/miscellaneous/ - 2018-09-12 + 2018-09-13 daily /user-guide/monitoring/ - 2018-09-12 + 2018-09-13 daily /user-guide/multiple-ingress/ - 2018-09-12 + 2018-09-13 daily /user-guide/tls/ - 2018-09-12 + 2018-09-13 daily /user-guide/third-party-addons/modsecurity/ - 2018-09-12 + 2018-09-13 daily /user-guide/third-party-addons/opentracing/ - 2018-09-12 + 2018-09-13 daily /examples/ - 2018-09-12 + 2018-09-13 daily /examples/PREREQUISITES/ - 2018-09-12 + 2018-09-13 daily /examples/affinity/cookie/README/ - 2018-09-12 + 2018-09-13 daily /examples/auth/basic/README/ - 2018-09-12 + 2018-09-13 daily /examples/auth/client-certs/README/ - 2018-09-12 + 2018-09-13 daily /examples/auth/external-auth/README/ - 2018-09-12 + 2018-09-13 daily /examples/auth/oauth-external-auth/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/configuration-snippets/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/custom-configuration/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/custom-errors/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/custom-headers/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/custom-upstream-check/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/external-auth-headers/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/ssl-dh-param/README/ - 2018-09-12 + 2018-09-13 daily /examples/customization/sysctl/README/ - 2018-09-12 + 2018-09-13 daily /examples/docker-registry/README/ - 2018-09-12 + 2018-09-13 daily /examples/grpc/README/ - 2018-09-12 + 2018-09-13 daily /examples/multi-tls/README/ - 2018-09-12 + 2018-09-13 daily /examples/rewrite/README/ - 2018-09-12 + 2018-09-13 daily /examples/static-ip/README/ - 2018-09-12 + 2018-09-13 daily /examples/tls-termination/README/ - 2018-09-12 + 2018-09-13 daily /development/ - 2018-09-12 + 2018-09-13 daily /how-it-works/ - 2018-09-12 + 2018-09-13 daily /troubleshooting/ - 2018-09-12 + 2018-09-13 daily \ No newline at end of file