Document (and add!) new flags for 1.0.0 #871
Conversation
|
Was originally going to rebase this to main or open up a separate PR with only the commit that adds the defaults, but on further review, while this is still a goof, it shouldn't matter. Everything in question defaults to https://github.com/spf13/viper/blob/v1.7.1/viper.go#L797-L799 https://github.com/spf13/cast/blob/v1.3.1/cast.go#L12-L15 No one was ever the wiser! So still 🤦♀️ but doesn't warrant a patch release to fix the issue in 0.10.x. |
docs/references/cli-arguments.md
Outdated
| @@ -59,6 +62,9 @@ Following table describes all the flags that are available: | |||
| | --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.| | |||
| | --skip-classless-ingress-v1beta1 |`boolean` | `false` | Toggles whether the controller processes `extensions/v1beta1` and `networking/v1beta1` Ingress resources that have no `kubernetes.io/ingress.class` annotation.| | |||
There was a problem hiding this comment.
This should be --process-classless-ingress-v1
There was a problem hiding this comment.
LGTM.
This PR wouldn't have been needed in the first place (and discrepancies wouldn't have had a chance to occur) if we had implemented the improvements below:
- delete the flags reference from docs and point to flag defs directly instead #880: flag documentation existing both in flag definitions and in markdown - we're susceptible to discrepancy
- simplify viper flag unmarshaling #868: the need to touch several places in the code when introducing a new flag - there's potential for accidental omission
| @@ -37,6 +37,9 @@ Following table describes all the flags that are available: | |||
| | --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.| | |||
| | --disable-ingress-extensionsv1beta1 |`boolean` | `false` | Disable processing Ingress resources with apiVersion `extensions/v1beta1`.| | |||
There was a problem hiding this comment.
non-blocking: I don't see a point in maintaining this table separately from pflag flag definitions in the code (and the --help resulting from there).
By maintaining it, we're asking for extra maintenance burden, and discrepancy bugs.
Tracked (and the necessity of this table to be discussed with @rainest @hbagdi) in #880
What this PR does / why we need it:
Adds documentation for new Ingress API version and class matching flags.
Adds several flags that I forgot to add everywhere earlier 🤦
Special notes for your reviewer:
Whoops, forgot to touch all the flag instances in flags.go in #843 🤦