Skip to content

Commit 50e908a

Browse files
Update links in docs
1 parent 9b1af26 commit 50e908a

File tree

17 files changed

+22
-22
lines changed

17 files changed

+22
-22
lines changed

examples-of-custom-resources/advanced-routing/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Advanced Routing
22

3-
In this example we use the [VirtualServer](../../docs/virtualserver-and-virtualserverroute.md) resource to configure advanced routing for the cafe application from the [Basic Configuration](../basic-configuration/) example, for which we have introduced the following changes:
3+
In this example we use the [VirtualServer](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) resource to configure advanced routing for the cafe application from the [Basic Configuration](../basic-configuration/) example, for which we have introduced the following changes:
44
* Instead of one version of the tea service, we have two: `tea-post-svc` and `tea-svc`. We send POST requests for tea to `tea-post-svc` and non-POST requests, such as GET requests, to `tea-svc`.
55
* Instead of one version of the coffee service, we have two: `coffee-v1-svc` and `coffee-v2-svc`. We send requests that include the cookie `version` set to `v2` to `coffee-v2-svc` and all other requests to `coffee-v1-svc`.
66
* To simplify the example, we have removed TLS termination.
77

88
## Prerequisites
99

10-
1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
10+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller with custom resources enabled.
1111
1. Save the public IP address of the Ingress Controller into a shell variable:
1212
```
1313
$ IC_IP=XXX.YYY.ZZZ.III

examples-of-custom-resources/basic-configuration/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Basic Configuration
22

3-
In this example we configure load balancing with TLS termination for a simple web application using the [VirtualServer](../../docs/virtualserver-and-virtualserverroute.md) resource. The application, called cafe, lets you get either tea via the tea service or coffee via the coffee service. You indicate your drink preference with the URI of your HTTP request: URIs ending with `/tea` get you tea and URIs ending with `/coffee` get you coffee.
3+
In this example we configure load balancing with TLS termination for a simple web application using the [VirtualServer](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) resource. The application, called cafe, lets you get either tea via the tea service or coffee via the coffee service. You indicate your drink preference with the URI of your HTTP request: URIs ending with `/tea` get you tea and URIs ending with `/coffee` get you coffee.
44

55
The example is similar to the [complete example](../../examples/complete-example/README.md). However, instead of the Ingress resource, we use the VirtualServer.
66

77
## Prerequisites
88

9-
1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
9+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller with custom resources enabled.
1010
1. Save the public IP address of the Ingress Controller into a shell variable:
1111
```
1212
$ IC_IP=XXX.YYY.ZZZ.III

examples-of-custom-resources/cross-namespace-configuration/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Cross-Namespace Configuration
22

3-
In this example we use the [VirtualServer and VirtualServerRoute](../../docs/virtualserver-and-virtualserverroute.md) resources to configure load balancing for the modified cafe application from the [Basic Configuration](../basic-configuration/) example. We have put the load balancing configuration as well as the deployments and services into multiple namespaces. Instead of one namespace, we now use three: `tea`, `coffee`, and `cafe`.
3+
In this example we use the [VirtualServer and VirtualServerRoute](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) resources to configure load balancing for the modified cafe application from the [Basic Configuration](../basic-configuration/) example. We have put the load balancing configuration as well as the deployments and services into multiple namespaces. Instead of one namespace, we now use three: `tea`, `coffee`, and `cafe`.
44
* In the tea namespace, we create the tea deployment, service, and the corresponding load-balancing configuration.
55
* In the coffee namespace, we create the coffee deployment, service, and the corresponding load-balancing configuration.
66
* In the cafe namespace, we create the cafe secret with the TLS certificate and key and the load-balancing configuration for the cafe application. That configuration references the coffee and tea configurations.
77

88
## Prerequisites
99

10-
1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
10+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller with custom resources enabled.
1111
1. Save the public IP address of the Ingress Controller into a shell variable:
1212
```
1313
$ IC_IP=XXX.YYY.ZZZ.III

examples-of-custom-resources/traffic-splitting/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Traffic Splitting
22

3-
In this example we use the [VirtualServer](../../docs/virtualserver-and-virtualserverroute.md) resource to configure traffic splitting for the cafe application from the [Basic Configuration](../basic-configuration/) example, for which we have introduced the following changes:
3+
In this example we use the [VirtualServer](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) resource to configure traffic splitting for the cafe application from the [Basic Configuration](../basic-configuration/) example, for which we have introduced the following changes:
44
* Instead of one version of the coffee service, we have two: `coffee-v1-svc` and `coffee-v2-svc`. We send 90% of the coffee traffic to `coffee-v1-svc` and the remaining 10% to `coffee-v2-svc`.
55
* To simplify the example, we have removed TLS termination and the tea service.
66

77
## Prerequisites
88

9-
1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
9+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller with custom resources enabled.
1010
1. Save the public IP address of the Ingress Controller into a shell variable:
1111
```
1212
$ IC_IP=XXX.YYY.ZZZ.III

examples/complete-example/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In this example we deploy the NGINX or NGINX Plus Ingress controller, a simple w
66

77
## 1. Deploy the Ingress Controller
88

9-
1. Follow the installation [instructions](../../docs/installation.md) to deploy the Ingress controller.
9+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress controller.
1010

1111
2. Save the public IP address of the Ingress controller into a shell variable:
1212
```

examples/custom-annotations/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Let's create a set of custom annotations to support [rate-limiting](https://ngin
99

1010
## Prerequisites
1111

12-
* Read the [custom annotations doc](../../docs/custom-annotations.md) before going through this example first.
12+
* Read the [custom annotations doc](https://docs.nginx.com/nginx-ingress-controller/configuration/ingress-resources/custom-annotations/) before going through this example first.
1313
* Read about [custom templates](../custom-templates).
1414

1515
## Step 1 - Customize the Template

examples/custom-templates/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom Templates
22

3-
The Ingress controller allows you to customize your templates through a [ConfigMap](../../docs/configmap-and-annotations.md) via the following keys:
3+
The Ingress controller allows you to customize your templates through a [ConfigMap](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) via the following keys:
44
* `main-template` - Sets the main NGINX configuration template.
55
* `ingress-template` - Sets the Ingress NGINX configuration template for an Ingress resource.
66

examples/customization/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Customization of NGINX Configuration
22

3-
This example has been transformed into the [ConfigMap and Annotations doc](../../docs/configmap-and-annotations.md).
3+
This example has been transformed into the [ConfigMap](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) and [Annotations](https://docs.nginx.com/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations/) doc.

examples/daemon-set/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
You can deploy the NGINX or NGINX Plus controller as a [Daemon Set](https://kubernetes.io/docs/admin/daemons/). This allows you to deploy the controller on all or select nodes of your cluster.
44

5-
Read the installation instructions [here](../../docs/installation.md).
5+
Read the installation instructions [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).

examples/externalname-services/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ data:
2121
resolver-addresses: "10.0.0.10"
2222
```
2323
24-
Additional resolver parameters, including the caching of DNS records, are available. Check the corresponding [ConfigMap and Annotations](../../docs/configmap-and-annotations.md) section.
24+
Additional resolver parameters, including the caching of DNS records, are available. Check the corresponding [ConfigMap](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) section.
2525
2626
2727
## Example

examples/grpc-services/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To support a gRPC application with NGINX Ingress controllers, you need to add th
44

55
## Prerequisites
66

7-
* HTTP/2 must be enabled. See `http2` ConfigMap key in the [ConfigMap and Annotations doc](../../docs/configmap-and-annotations.md).
7+
* HTTP/2 must be enabled. See `http2` ConfigMap key in the [ConfigMap](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/#listeners)
88
* Ingress resources for gRPC applications must include TLS termination.
99

1010
## Syntax

examples/mergeable-ingress-types/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ load balancing for that application using Ingress resources with the `nginx.org/
6363

6464
## 1. Deploy the Ingress Controller
6565

66-
1. Follow the installation [instructions](../../docs/installation.md) to deploy the Ingress controller.
66+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress controller.
6767

6868
2. Save the public IP address of the Ingress controller into a shell variable:
6969
```
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Using Multiple Ingress Controllers
22

3-
This example has been transformed into the [Multiple Ingress Controllers doc](../../docs/multiple-ingress-controllers.md).
3+
This example has been transformed into the [Multiple Ingress Controllers doc](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/).

examples/opentracing/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In this example we deploy the NGINX or NGINX Plus Ingress Controller and a simpl
55

66
## Prerequisites
77

8-
The default Ingress Controller images don’t include the OpenTracing module required for this example. See Step 1 of the [Prerequisites section](../../docs/opentracing.md#Prerequisites) in the OpenTracing doc for the instructions on how to get the right image with Jaeger tracer.
8+
The default Ingress Controller images do not include the OpenTracing module required for this example. See Step 1 of the [Prerequisites section](https://docs.nginx.com/nginx-ingress-controller/third-party-modules/opentracing/#prerequisites) in the OpenTracing doc for the instructions on how to get the right image with Jaeger tracer.
99

1010
## Step 1 - Deploy Ingress Controller and the Cafe App
1111

examples/rbac/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# RBAC
22

3-
It is possible to run the Ingress controller in a cluster with [RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) enabled. Read the installation instructions [here](../../docs/installation.md).
3+
It is possible to run the Ingress controller in a cluster with [RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) enabled. Read the installation instructions [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).

examples/tcp-udp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Support for TCP/UDP Load Balancing
22

3-
In this example we deploy the NGINX or NGINX Plus Ingress controller, a DNS server and then configure both TCP and UDP load balancing for the DNS server using the `stream-snippets` [ConfigMap key](../../docs/configmap-and-annotations.md).
3+
In this example we deploy the NGINX or NGINX Plus Ingress controller, a DNS server and then configure both TCP and UDP load balancing for the DNS server using the `stream-snippets` [ConfigMap key](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/).
44

55
The standard Kubernetes Ingress resources assume that all traffic is HTTP-based; they do not cater for the case of basic TCP or UDP load balancing. In this example, we use the `stream-snippets` ConfigMap key to embed the required TCP and UDP load-balancing configuration directly into the `stream{}` block of the NGINX configuration file.
66

@@ -15,7 +15,7 @@ With NGINX, we’ll use the DNS name or virtual IP address to identify the servi
1515

1616
### 1. Deploy the Ingress Controller
1717

18-
1. Follow the installation [instructions](../../docs/installation.md) to deploy the Ingress controller. Make sure to expose port 5353 of the Ingress controller
18+
1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress controller. Make sure to expose port 5353 of the Ingress controller
1919
both for TCP and UDP traffic.
2020

2121
2. Save the public IP address of the Ingress controller into a shell variable:

examples/wildcard-tls-certificate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The wildcard TLS certificate simplifies the configuration of TLS termination if
66

77
### Prerequisites
88

9-
Start the Ingress Controller with the `-wildcard-tls-secret` [command-line argument](../../docs/cli-arguments.md) set to a TLS secret with a wildcard cert/key. For example:
9+
Start the Ingress Controller with the `-wildcard-tls-secret` [command-line argument](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/) set to a TLS secret with a wildcard cert/key. For example:
1010

1111
```yaml
1212
-wildcard-tls-secret=nginx-ingress/wildlcard-tls-secret

0 commit comments

Comments
 (0)