Annotations documentation correction

[aronsajan]

What happened:

The annotations.md documentation have a mistake regarding proxy request buffering - nginx.ingress.kubernetes.io/proxy-request-buffering is considered as a timeout parameter.

What you expected to happen:

nginx.ingress.kubernetes.io/proxy-request-buffering is supposed to be either “on” or “off”

Documentation Error

NGINX Ingress controller version (exec into the pod and run nginx-ingress-controller --version.):

Kubernetes version (use kubectl version):

Environment:

• Cloud provider or hardware configuration:

• OS (e.g. from /etc/os-release):

• Kernel (e.g. uname -a):

• Install tools:

  • Please mention how/where was the cluster created like kubeadm/kops/minikube/kind etc.

• Basic cluster related info:

  • kubectl version
  • kubectl get nodes -o wide

• How was the ingress-nginx-controller installed:

  • If helm was used then please show output of helm ls -A | grep -i ingress
  • If helm was used then please show output of helm -n <ingresscontrollernamespace> get values <helmreleasename>
  • If helm was not used, then copy/paste the complete precise command used to install the controller, along with the flags and options used
  • if you have more than one instance of the ingress-nginx-controller installed in the same cluster, please provide details for all the instances

• Current State of the controller:

  • kubectl describe ingressclasses
  • kubectl -n <ingresscontrollernamespace> get all -A -o wide
  • kubectl -n <ingresscontrollernamespace> describe po <ingresscontrollerpodname>
  • kubectl -n <ingresscontrollernamespace> describe svc <ingresscontrollerservicename>

• Current state of ingress object, if applicable:

  • kubectl -n <appnamespace> get all,ing -o wide
  • kubectl -n <appnamespace> describe ing <ingressname>
  • If applicable, then, your complete and exact curl/grpcurl command (redacted if required) and the reponse to the curl/grpcurl command with the -v flag

• Others:

  • Any other related information like ;
    • copy/paste of the snippet (if applicable)
    • kubectl describe ... of any custom configmap(s) created and in use
    • Any other related information that may help

How to reproduce this issue:

Anything else we need to know:

[longwuyuan]

@aronsajan Thank you very much for pointing this out

Can you kindly help some more by providing a link to what you claim. It will reduce the effort for someone who wants to create a PR for editing docs.

Of if you want to submit a docs PR for the reflecting the change clearly, it will be most welcome

/triage accepted
/kind docs
/area documentation
/priority important-longterm
/help
/assign

[k8s-ci-robot]

@longwuyuan:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

@aronsajan Thank you very much for pointing this out

Can you kindly help some more by providing a link to what you claim. It will reduce the effort for someone who wants to create a PR for editing docs.

Of if you want to submit a docs PR for the reflecting the change clearly, it will be most welcome

/triage accepted
/kind docs
/area documentation
/priority important-longterm
/help
/assign

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

@longwuyuan: The label(s) kind/docs, area/documentation cannot be applied, because the repository doesn't have them.

In response to this:

@aronsajan Thank you very much for pointing this out

Can you kindly help some more by providing a link to what you claim. It will reduce the effort for someone who wants to create a PR for editing docs.

Of if you want to submit a docs PR for the reflecting the change clearly, it will be most welcome

/triage accepted
/kind docs
/area documentation
/priority important-longterm
/help
/assign

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[longwuyuan]

/kind docuementation
/area docs