DevFW-CICD/ingress-nginx-helm
12
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove deprecated flags and update docs

Browse source
This commit is contained in:
Manuel Alejandro de Brito Fontes 2020-04-12 09:58:51 -04:00
parent 527a440e2e
commit 9c6873a55d
3 changed files with 55 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
cmd/nginx/flags.go
View file

@ -112,11 +112,6 @@ Requires setting the publish-service parameter to a valid Service reference.`)
electionID = flags.String("election-id", "ingress-controller-leader", electionID = flags.String("election-id", "ingress-controller-leader",
`Election id to use for Ingress status updates.`) `Election id to use for Ingress status updates.`)
_ = flags.Bool("force-namespace-isolation", false,
`Force namespace isolation.
Prevents Ingress objects from referencing Secrets and ConfigMaps located in a
different namespace than their own. May be used together with watch-namespace.`)
updateStatusOnShutdown = flags.Bool("update-status-on-shutdown", true, updateStatusOnShutdown = flags.Bool("update-status-on-shutdown", true,
`Update the load-balancer status of Ingress objects when the controller shuts down. `Update the load-balancer status of Ingress objects when the controller shuts down.
Requires the update-status parameter.`) Requires the update-status parameter.`)
@ -146,9 +141,6 @@ extension for this to succeed.`)
`Customized address to set as the load-balancer status of Ingress objects this controller satisfies. `Customized address to set as the load-balancer status of Ingress objects this controller satisfies.
Requires the update-status parameter.`) Requires the update-status parameter.`)
_ = flags.Bool("enable-dynamic-certificates", true,
`Dynamically update SSL certificates instead of reloading NGINX. Feature backed by OpenResty Lua libraries.`)
enableMetrics = flags.Bool("enable-metrics", true, enableMetrics = flags.Bool("enable-metrics", true,
`Enables the collection of NGINX metrics`) `Enables the collection of NGINX metrics`)
metricsPerHost = flags.Bool("metrics-per-host", true, metricsPerHost = flags.Bool("metrics-per-host", true,
@ -180,10 +172,6 @@ Takes the form "<host>:port". If not provided, no admission controller is starte
statusUpdateInterval = flags.Int("status-update-interval", status.UpdateInterval, "Time interval in seconds in which the status should check if an update is required. Default is 60 seconds") statusUpdateInterval = flags.Int("status-update-interval", status.UpdateInterval, "Time interval in seconds in which the status should check if an update is required. Default is 60 seconds")
) )
flags.MarkDeprecated("force-namespace-isolation", `This flag doesn't do anything.`)
flags.MarkDeprecated("enable-dynamic-certificates", `Only dynamic mode is supported`)
flags.StringVar(&nginx.MaxmindLicenseKey, "maxmind-license-key", "", `Maxmind license key to download GeoLite2 Databases. flags.StringVar(&nginx.MaxmindLicenseKey, "maxmind-license-key", "", `Maxmind license key to download GeoLite2 Databases.
https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases`) https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases`)
flags.StringVar(&nginx.MaxmindEditionIDs, "maxmind-edition-ids", "GeoLite2-City,GeoLite2-ASN", `Maxmind edition ids to download GeoLite2 Databases.`) flags.StringVar(&nginx.MaxmindEditionIDs, "maxmind-edition-ids", "GeoLite2-City,GeoLite2-ASN", `Maxmind edition ids to download GeoLite2 Databases.`)

2
docs/kubectl-plugin.md
View file

@ -160,7 +160,7 @@ Add the `--list` option to show only the backend names. Add the `--backend <back
### certs ### certs
Use `kubectl ingress-nginx certs --host <hostname>` to dump the SSL cert/key information for a given host. Requires that `--enable-dynamic-certificates` is `true` (this is the default as of version `0.24.0`). Use `kubectl ingress-nginx certs --host <hostname>` to dump the SSL cert/key information for a given host.
**WARNING:** This command will dump sensitive private key information. Don't blindly share the output, and certainly don't log it anywhere. **WARNING:** This command will dump sensitive private key information. Don't blindly share the output, and certainly don't log it anywhere.

100
docs/user-guide/cli-arguments.md
View file

@ -6,49 +6,57 @@ They are set in the container spec of the `nginx-ingress-controller` Deployment
| Argument | Description | | Argument | Description |
|----------|-------------| |----------|-------------|
| `--alsologtostderr` | log to standard error as well as files | | `--add_dir_header` | If true, adds the file directory to the header |
| `--annotations-prefix string` | Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io") | | `--alsologtostderr` | log to standard error as well as files |
| `--apiserver-host string` | Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted. | | `--annotations-prefix` | Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io") |
| `--configmap string` | Name of the ConfigMap containing custom global configurations for the controller. | | `--apiserver-host` | Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted. |
| `--default-backend-service string` | Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service. If not specified, a 404 page will be returned directly from NGINX.| | `--certificate-authority` | Path to a cert file for the certificate authority. This certificate is used only when the flag --apiserver-host is specified. |
| `--default-server-port int` | When `default-backend-service` is not specified or specified service does not have any endpoint, a local endpoint with this port will be used to serve 404 page from inside Nginx. | | `--configmap` | Name of the ConfigMap containing custom global configurations for the controller. |
| `--default-ssl-certificate string` | Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name". | | `--default-backend-service` | Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service. |
| `--disable-catch-all` | Disable support for catch-all Ingresses. | | `--default-server-port` | Port to use for exposing the default server (catch-all). (default 8181) |
| `--election-id string` | Election id to use for Ingress status updates. (default "ingress-controller-leader") | | `--default-ssl-certificate` | Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name". |
| `--enable-dynamic-certificates` | Dynamically serves certificates instead of reloading NGINX when certificates are created, updated, or deleted. Currently does not support OCSP stapling, so --enable-ssl-chain-completion must be turned off (default behaviour). Assuming the certificate is generated with a 2048 bit RSA key/cert pair, this feature can store roughly 5000 certificates. Once the backing Lua shared dictionary `certificate_data` is full, the least recently used certificate will be removed to store new ones. (enabled by default) | | `--disable-catch-all` | Disable support for catch-all Ingresses |
| `--enable-metrics` | Enable the collection of metrics for scraping by Prometheus (default true) | | `--election-id` | Election id to use for Ingress status updates. (default "ingress-controller-leader") |
| `--enable-ssl-chain-completion` | Autocomplete SSL certificate chains with missing intermediate CA certificates. A valid certificate chain is required to enable OCSP stapling. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default true) | | `--enable-metrics` | Enables the collection of NGINX metrics (default true) |
| `--enable-ssl-passthrough` | Enable SSL Passthrough. | | `--enable-ssl-chain-completion` | Autocomplete SSL certificate chains with missing intermediate CA certificates. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. |
| `--health-check-path string` | URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz") | | `--enable-ssl-passthrough` | Enable SSL Passthrough. |
| `--health-check-timeout duration` | Time limit, in seconds, for a probe to health-check-path to succeed. (default 10) | | `--health-check-path` | URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz") |
| `--healthz-port int` | Port to use for the healthz endpoint. (default 10254) | | `--health-check-timeout` | Time limit, in seconds, for a probe to health-check-path to succeed. (default 10) |
| `--http-port int` | Port to use for servicing HTTP traffic. (default 80) | | `--healthz-port` | Port to use for the healthz endpoint. (default 10254) |
| `--https-port int` | Port to use for servicing HTTPS traffic. (default 443) | | `--http-port` | Port to use for servicing HTTP traffic. (default 80) |
| `--status-port int` | Port to use for the lua HTTP endpoint configuration. (default 10246) | | `--https-port` | Port to use for servicing HTTPS traffic. (default 443) |
| `--stream-port int` | Port to use for the lua TCP/UDP endpoint configuration. (default 10247) | | `--ingress-class` | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the field IngressClassName in Kubernetes clusters version v1.18.0 or higher or the annotation "kubernetes.io/ingress.class" (deprecated). All ingress classes are satisfied if this parameter is not set. |
| `--ingress-class string` | Name of the ingress class this controller satisfies. The class of an Ingress object is set using the annotation "kubernetes.io/ingress.class". All ingress classes are satisfied if this parameter is left empty. | | `--kubeconfig` | Path to a kubeconfig file containing authorization and API server information. |
| `--kubeconfig string` | Path to a kubeconfig file containing authorization and API server information. | | `--log_backtrace_at` | when logging hits line file:N, emit a stack trace (default :0) |
| `--log_backtrace_at traceLocation` | when logging hits line file:N, emit a stack trace (default :0) | | `--log_dir` | If non-empty, write log files in this directory |
| `--log_dir string` | If non-empty, write log files in this directory | | `--log_file` | If non-empty, use this log file |
| `--logtostderr` | log to standard error instead of files (default true) | | `--log_file_max_size` | Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) |
| `--metrics-per-host` | enable host labels for prometheus metrics. You may want to disable this to reduce the number of time-series created. (default true) | | `--logtostderr` | log to standard error instead of files (default true) |
| `--profiling` | Enable profiling via web interface host:port/debug/pprof/ (default true) | | `--maxmind-edition-ids` | Maxmind edition ids to download GeoLite2 Databases. (default "GeoLite2-City,GeoLite2-ASN") |
| `--publish-service string` | Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it satisfies. | | `--maxmind-license-key` | Maxmind license key to download GeoLite2 Databases. https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases |
| `--publish-status-address string` | Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter. | | `--metrics-per-host` | Export metrics per-host (default true) |
| `--report-node-internal-ip-address` | Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter. | | `--profiler-port` | Port to use for expose the ingress controller Go profiler when it is enabled. (default 10245) |
| `--ssl-passthrough-proxy-port int` | Port to use internally for SSL Passthrough. (default 442) | | `--profiling` | Enable profiling via web interface host:port/debug/pprof/ (default true) |
| `--stderrthreshold severity` | logs at or above this threshold go to stderr (default 2) | | `--publish-service` | Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it atisfies. |
| `--sync-period duration` | Period at which the controller forces the repopulation of its local object stores. Disabled by default. | | `--publish-status-address` | Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter. |
| `--sync-rate-limit float32` | Define the sync frequency upper limit (default 0.3) | | `--report-node-internal-ip-address`| Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter. |
| `--tcp-services-configmap string` | Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic. | | `--skip_headers` | If true, avoid header prefixes in the log messages |
| `--udp-services-configmap string` | Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number. | | `--skip_log_headers` | If true, avoid headers when opening log files |
| `--update-status` | Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true) | | `--ssl-passthrough-proxy-port` | Port to use internally for SSL Passthrough. (default 442) |
| `--update-status-on-shutdown` | Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true) | | `--status-port` | Port to use for the lua HTTP endpoint configuration. (default 10246) |
| `--status-update-interval` | Time interval in seconds in which the status should check if an update is required. (default 60 seconds) | | `--status-update-interval` | Time interval in seconds in which the status should check if an update is required. Default is 60 seconds (default 60) |
| `-v`, `--v Level` | log level for V logs | | `--stderrthreshold` | logs at or above this threshold go to stderr (default 2) |
| `--version` | Show release information about the NGINX Ingress controller and exit. | | `--stream-port` | Port to use for the lua TCP/UDP endpoint configuration. (default 10247) |
| `--vmodule moduleSpec` | comma-separated list of pattern=N settings for file-filtered logging | | `--sync-period` | Period at which the controller forces the repopulation of its local object stores. Disabled by default. |
| `--watch-namespace string` | Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty. | | `--sync-rate-limit` | Define the sync frequency upper limit (default 0.3) |
|`--validating-webhook`|The address to start an admission controller on| | `--tcp-services-configmap` | Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic. |
|`--validating-webhook-certificate`|The certificate the webhook is using for its TLS handling| | `--udp-services-configmap` | Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number. |
|`--validating-webhook-key`|The key the webhook is using for its TLS handling| | `--update-status` | Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true) |
| `--update-status-on-shutdown` | Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true) |
| `-v, --v Level` | number for the log level verbosity |
| `--validating-webhook` | The address to start an admission controller on to validate incoming ingresses. Takes the form "<host>:port". If not provided, no admission controller is started. |
| `--validating-webhook-certificate` | The path of the validating webhook certificate PEM. |
| `--validating-webhook-key` | The path of the validating webhook key PEM. |
| `--version` | Show release information about the NGINX Ingress controller and exit. |
| `--vmodule` | comma-separated list of pattern=N settings for file-filtered logging |
| `--watch-namespace` | Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty. |