From 4bdf47f96f761344b8e02f1338b804eafa5a2f15 Mon Sep 17 00:00:00 2001 From: Manuel de Brito Fontes Date: Fri, 16 Jun 2017 16:12:15 -0400 Subject: [PATCH] Add information about nginx controller flags --- controllers/nginx/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/controllers/nginx/README.md b/controllers/nginx/README.md index 1ecbe55564..858fca45cc 100644 --- a/controllers/nginx/README.md +++ b/controllers/nginx/README.md @@ -5,6 +5,7 @@ This is an nginx Ingress controller that uses [ConfigMap](https://github.com/kub ## Contents * [Conventions](#conventions) * [Requirements](#requirements) +* [Command line arguments](#command-line-arguments) * [Dry running](#try-running-the-ingress-controller) * [Deployment](#deployment) * [HTTP](#http) @@ -41,6 +42,38 @@ Anytime we reference a tls secret, we mean (x509, pem encoded, RSA 2048, etc). Y - Default backend [404-server](https://github.com/kubernetes/contrib/tree/master/404-server) +## Command line arguments +``` +Usage of : + --alsologtostderr log to standard error as well as files + --apiserver-host string The address of the Kubernetes Apiserver to connect to in the format of protocol://address:port, e.g., http://localhost:8080. If not specified, the assumption is that the binary runs inside a Kubernetes cluster and local discovery is attempted. + --configmap string Name of the ConfigMap that contains the custom configuration use + --default-backend-service string Service used to serve a 404 page for the default backend. Takes the form namespace/name. The controller uses the first node port of this Service for the default backend. + --default-ssl-certificate string Name of the secret that contains a SSL certificate to be used as default for a HTTPS catch-all server + --election-id string Election id to use for status update. (default "ingress-controller-leader") + --force-namespace-isolation Force namespace isolation. This flag is required to avoid the reference of secrets or configmaps located in a different namespace than the specified in the flag --watch-namespace. + --health-check-path string Defines the URL to be used as health check inside in the default server in NGINX. (default "/healthz") + --healthz-port int port for healthz endpoint. (default 10254) + --ingress-class string Name of the ingress class to route through this controller. + --kubeconfig string Path to kubeconfig file with authorization and master location information. + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --logtostderr log to standard error instead of files + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --publish-service string Service fronting the ingress controllers. Takes the form namespace/name. The controller will set the endpoint records on the ingress objects to reflect those on the service. + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + --sync-period duration Relist and confirm cloud resources this often. (default 1m0s) + --tcp-services-configmap string Name of the ConfigMap that contains the definition of the TCP services to expose. + The key in the map indicates the external port to be used. The value is the name of the service with the format namespace/serviceName and the port of the service could be a number of the name of the port. + The ports 80 and 443 are not allowed as external ports. This ports are reserved for the backend + --udp-services-configmap string Name of the ConfigMap that contains the definition of the UDP services to expose. + The key in the map indicates the external port to be used. The value is the name of the service with the format namespace/serviceName and the port of the service could be a number of the name of the port. + --update-status Indicates if the ingress controller should update the Ingress status IP/hostname. Default is true (default true) +-v, --v Level log level for V logs + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging + --watch-namespace string Namespace to watch for Ingress. Default is to watch all namespaces +``` + ## Try running the Ingress controller Before deploying the controller to production you might want to run it outside the cluster and observe it.