From aa59c53fc6ca7764b680c78cc228d3cc07d66faa Mon Sep 17 00:00:00 2001
From: Karl Stoney <me@karlstoney.com>
Date: Thu, 1 Feb 2018 17:05:05 +0000
Subject: [PATCH] Added documentation for Permanent Redirect (#2018)

---
 docs/user-guide/annotations.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/user-guide/annotations.md b/docs/user-guide/annotations.md
index 5a5d728202..97ff894b16 100644
--- a/docs/user-guide/annotations.md
+++ b/docs/user-guide/annotations.md
@@ -36,6 +36,7 @@ The following annotations are supported:
 |[nginx.ingress.kubernetes.io/from-to-www-redirect](#redirect-from-to-www)|"true" or "false"|
 |[nginx.ingress.kubernetes.io/limit-connections](#rate-limiting)|number|
 |[nginx.ingress.kubernetes.io/limit-rps](#rate-limiting)|number|
+|[nginx.ingress.kubernetes.io/permanent-redirect](#permanent-redirect)|string|
 |[nginx.ingress.kubernetes.io/proxy-body-size](#custom-max-body-size)|string|
 |[nginx.ingress.kubernetes.io/proxy-connect-timeout](#custom-timeouts)|number|
 |[nginx.ingress.kubernetes.io/proxy-send-timeout](#custom-timeouts)|number|
@@ -324,6 +325,9 @@ The annotation `nginx.ingress.kubernetes.io/limit-rate`, `nginx.ingress.kubernet
 
 To configure this setting globally for all Ingress rules, the `limit-rate-after` and `limit-rate` value may be set in the NGINX ConfigMap. if you set the value in ingress annotation will cover global setting.
 
+### Permanent Redirect
+This annotation allows to return a permanent redirect instead of sending data to the upstream.  For example `nginx.ingress.kubernetes.io/permanent-redirect: https://www.google.com` would redirect everything to Google.
+
 ### SSL Passthrough
 
 The annotation `nginx.ingress.kubernetes.io/ssl-passthrough` allows to configure TLS termination in the pod and not in NGINX.