Rewrite ¶
This example demonstrates how to use Rewrite annotations.
Prerequisites ¶
You will need to make sure your Ingress targets exactly one Ingress controller by specifying the ingress.class annotation, and that you have an ingress controller running in your cluster.
Deployment ¶
Rewriting can be controlled using the following annotations:
| Name | Description | Values |
|---|---|---|
| nginx.ingress.kubernetes.io/rewrite-target | Target URI where the traffic must be redirected | string |
| nginx.ingress.kubernetes.io/ssl-redirect | Indicates if the location section is only accessible via SSL (defaults to True when Ingress contains a Certificate) | bool |
| nginx.ingress.kubernetes.io/force-ssl-redirect | Forces the redirection to HTTPS even if the Ingress is not TLS Enabled | bool |
| nginx.ingress.kubernetes.io/app-root | Defines the Application Root that the Controller must redirect if it's in / context | string |
| nginx.ingress.kubernetes.io/use-regex | Indicates if the paths defined on an Ingress use regular expressions | bool |
Examples ¶
Rewrite Target ¶
Attention
Starting in Version 0.22.0, ingress definitions using the annotation nginx.ingress.kubernetes.io/rewrite-target are not backwards compatible with previous versions. In Version 0.22.0 and beyond, any substrings within the request URI that need to be passed to the rewritten path must explicitly be defined in a capture group.
Note
Captured groups are saved in numbered placeholders, chronologically, in the form $1, $2 ... $n. These placeholders can be used as parameters in the rewrite-target annotation.
Note
Please see the FAQ for Validation Of path
Create an Ingress rule with a rewrite annotation:
$ echo '
+ Rewrite - Ingress-Nginx Controller Rewrite ¶
This example demonstrates how to use Rewrite annotations.
Prerequisites ¶
You will need to make sure your Ingress targets exactly one Ingress controller by specifying the ingress.class annotation, and that you have an ingress controller running in your cluster.
Deployment ¶
Rewriting can be controlled using the following annotations:
Name Description Values nginx.ingress.kubernetes.io/rewrite-target Target URI where the traffic must be redirected string nginx.ingress.kubernetes.io/ssl-redirect Indicates if the location section is only accessible via SSL (defaults to True when Ingress contains a Certificate) bool nginx.ingress.kubernetes.io/force-ssl-redirect Forces the redirection to HTTPS even if the Ingress is not TLS Enabled bool nginx.ingress.kubernetes.io/app-root Defines the Application Root that the Controller must redirect if it's in / context string nginx.ingress.kubernetes.io/use-regex Indicates if the paths defined on an Ingress use regular expressions bool
Examples ¶
Rewrite Target ¶
Attention
Starting in Version 0.22.0, ingress definitions using the annotation nginx.ingress.kubernetes.io/rewrite-target are not backwards compatible with previous versions. In Version 0.22.0 and beyond, any substrings within the request URI that need to be passed to the rewritten path must explicitly be defined in a capture group.
Note
Captured groups are saved in numbered placeholders, chronologically, in the form $1, $2 ... $n. These placeholders can be used as parameters in the rewrite-target annotation.
Note
Please see the FAQ for Validation Of path
Create an Ingress rule with a rewrite annotation:
$ echo '
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 09a929d65..0922a0c1a 100644
Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ