Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update cli args for logging #864

Merged
merged 1 commit into from
Sep 21, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/references/cli-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ Following table describes all the flags that are available:
| --admission-webhook-cert |`string` | none | PEM-encoded certificate string for TLS handshake.|
| --admission-webhook-key |`string` | none | PEM-encoded private key string for TLS handshake.|
| --admission-webhook-listen |`string` | `off` | The address to start admission controller on (ip:port). Setting it to 'off' disables the admission controller.|
| --alsologtostderr |`boolean` | `false` | Logs are written to standard error as well as to files.|
| --anonymous-reports |`string` | `true` | Send anonymized usage data to help improve Kong.|
| --apiserver-host |`string` | none | 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.|
| --election-id |`string` | `ingress-controller-leader` | The name of ConfigMap (in the same namespace) to use to facilitate leader-election between multiple instances of the controller.|
Expand All @@ -51,22 +50,18 @@ Following table describes all the flags that are available:
| --kong-url |`string` | none | DEPRECATED, use `--kong-admin-url` |
| --kong-workspace |`string` | `default` | Workspace in Kong Enterprise to be configured.|
| --kong-custom-entities-secret |`string` | none | Secret containing custom entities to be populated in DB-less mode, takes the form `namespace/name`.|
| --log-format |`string` | `text` | Format of logs of the controller. Allowed values are `text` and `json`. |
| --log-level |`string` | `info` | Level of logging for the controller. Allowed values are `trace`, `debug`, `info`, `warn`, `error`, `fatal` and `panic`. |
| --enable-reverse-sync |`bool` | `false` | Enable reverse checks from Kong to Kubernetes. Use this option only if a human has edit access to Kong's Admin API. |
| --kubeconfig |`string` | none | Path to kubeconfig file with authorization and master location information.|
| --log_backtrace_at |`string` | none | When set to a file and line number holding a logging statement, such as -log_backtrace_at=gopherflakes.go:234 a stack trace will be written to the Info log whenever execution hits that statement. (Unlike with -vmodule, the ".go" must be present.)|
| --log_dir |`string` | none | If non-empty, write log files in this directory.|
| --logtostderr |`boolean` | `true` | Logs to standard error instead of files.|
| --profiling |`boolean` | `true` | Enable profiling via web interface `host:port/debug/pprof/`. |
| --publish-service |`string` | none | The namespaces and name of the Kubernetes Service fronting Kong Ingress Controller in the form of namespace/name. The controller will set the status of the Ingress resouces to match the endpoints of this service. In reference deployments, this is kong/kong-proxy.|
| --publish-status-address |`string` | none | User customized address to be set in the status of ingress resources. The controller will set the endpoint records on the ingress using this address.|
| --stderrthreshold |`string` | `2` | logs at or above this threshold go to stderr.|
| --sync-period |`duration` | `10m` | Relist and confirm cloud resources this often.|
| --sync-rate-limit |`float32` | `0.3` | Define the sync frequency upper limit. |
| --update-status |`boolean` | `true` | Indicates if the ingress controller should update the Ingress status IP/hostname.|
| --update-status-on-shutdown |`boolean` | `true` | Indicates if the ingress controller should update the Ingress status IP/hostname when the controller is being stopped.|
| -v, --v Level `int` | `0` | | Enable V-leveled logging at the specified level.|
| --version |`boolean` | `false` | Shows release information about the Kong Ingress controller.|
| --vmodule moduleSpec |`string` | none | The syntax of the argument is a comma-separated list of pattern=N, where pattern is a literal file name (minus the ".go" suffix) or "glob" pattern and N is a V level. For instance, -vmodule=gopher*=3 sets the V level to 3 in all Go files whose names begin "gopher".|
| --watch-namespace |`string` | none | Namespace to watch for Ingress and custom resources. The default value of an empty string results in the controller watching for resources in all namespaces and configuring Kong accordingly.|
| --help |`boolean` | `false` | Shows this documentation on the CLI and exit.|