ingress-nginx-helm/docs/index.md

# Overview

This is the documentation for the Ingress NGINX Controller.

It is built around the [Kubernetes Ingress resource](https://kubernetes.io/docs/concepts/services-networking/ingress/), using a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) to store the controller configuration.

You can learn more about using [Ingress](http://kubernetes.io/docs/user-guide/ingress/) in the official [Kubernetes documentation](https://docs.k8s.io).

# Getting Started

See [Deployment](./deploy/) for a whirlwind tour that will get you started.
Revise main documentation page (#8019) - Revise to be more in line with the style guide for Kubernetes official docs - Avoid recommending that readers use `k8s.io` namespaced controller names for their own custom controller configuration. Co-authored-by: James Strong <strong.james.e@gmail.com> Co-authored-by: James Strong <strong.james.e@gmail.com> 2021-12-12 13:21:58 +00:00			`# Overview`
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00
Minor documentation cleanup (#7826) * clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/ingress.yaml and the deployments referenced in https://github.com/kubernetes-retired/contrib/blob/4f2cb51ef82b4dddb625f6053ad132c1faf07aa1/ingress/controllers/nginx/examples/README.md They are not relevant to the current instructions. * add whitespace around parens * grammar setup would be a proper noun, but it is not the intended concept, which is a state * grammar * is-only * via * Use bullets for choices * ingress-controller nginx is a distinct brand. generally this repo talks about ingress-controller, although it is quite inconsistent about how... * drop stray paren * OAuth is a brand and needs an article here also GitHub is a brand * Indent text under numbered lists * use e.g. * Document that customer header config maps changes do not trigger updates This should be removed if https://github.com/kubernetes/ingress-nginx/issues/5238 is fixed. * article * period * infinitive verb + period * clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application * avoid using ; and reword * whitespace * brand: gRPC * only-does is the right form `for` adds nothing here * spelling: GitHub * punctuation `;` is generally not the right punctuation... * drop stray `to` * sentence * backticks * fix link * Improve readability of compare/vs * Renumber list * punctuation * Favor Ingress-NGINX and Ingress NGINX * Simplify custom header restart text * Undo typo damage Co-authored-by: Josh Soref <jsoref@users.noreply.github.com> 2022-01-17 00:57:28 +00:00			`This is the documentation for the Ingress NGINX Controller.`
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00
Revise main documentation page (#8019) - Revise to be more in line with the style guide for Kubernetes official docs - Avoid recommending that readers use `k8s.io` namespaced controller names for their own custom controller configuration. Co-authored-by: James Strong <strong.james.e@gmail.com> Co-authored-by: James Strong <strong.james.e@gmail.com> 2021-12-12 13:21:58 +00:00			`It is built around the [Kubernetes Ingress resource](https://kubernetes.io/docs/concepts/services-networking/ingress/), using a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) to store the controller configuration.`
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00
Revise main documentation page (#8019) - Revise to be more in line with the style guide for Kubernetes official docs - Avoid recommending that readers use `k8s.io` namespaced controller names for their own custom controller configuration. Co-authored-by: James Strong <strong.james.e@gmail.com> Co-authored-by: James Strong <strong.james.e@gmail.com> 2021-12-12 13:21:58 +00:00			`You can learn more about using [Ingress](http://kubernetes.io/docs/user-guide/ingress/) in the official [Kubernetes documentation](https://docs.k8s.io).`
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00
add faq section in docs 2023-05-26 18:28:19 +00:00			`# Getting Started`
Move all documentation under docs/ 2018-04-24 09:36:16 +00:00
Fix broken links in documentation (#4746) 2019-11-08 19:22:52 +00:00			`See [Deployment](./deploy/) for a whirlwind tour that will get you started.`
docs for migration to apiVersion networking.k8s.io/v1 (#7524) 2021-08-24 11:57:13 +00:00