Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc links #972

Merged
merged 6 commits into from
May 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples-of-custom-resources/advanced-routing/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Advanced Routing

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:
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:
* 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`.
* 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`.
* To simplify the example, we have removed TLS termination.

## Prerequisites

1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
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.
1. Save the public IP address of the Ingress Controller into a shell variable:
```
$ IC_IP=XXX.YYY.ZZZ.III
Expand Down
4 changes: 2 additions & 2 deletions examples-of-custom-resources/basic-configuration/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Basic Configuration

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.
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.

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

## Prerequisites

1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
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.
1. Save the public IP address of the Ingress Controller into a shell variable:
```
$ IC_IP=XXX.YYY.ZZZ.III
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Cross-Namespace Configuration

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`.
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`.
* In the tea namespace, we create the tea deployment, service, and the corresponding load-balancing configuration.
* In the coffee namespace, we create the coffee deployment, service, and the corresponding load-balancing configuration.
* 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.

## Prerequisites

1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
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.
1. Save the public IP address of the Ingress Controller into a shell variable:
```
$ IC_IP=XXX.YYY.ZZZ.III
Expand Down
4 changes: 2 additions & 2 deletions examples-of-custom-resources/traffic-splitting/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Traffic Splitting

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:
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:
* 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`.
* To simplify the example, we have removed TLS termination and the tea service.

## Prerequisites

1. Follow the [installation](../../docs/installation.md) instructions to deploy the Ingress Controller with custom resources enabled.
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.
1. Save the public IP address of the Ingress Controller into a shell variable:
```
$ IC_IP=XXX.YYY.ZZZ.III
Expand Down
2 changes: 1 addition & 1 deletion examples/complete-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In this example we deploy the NGINX or NGINX Plus Ingress controller, a simple w

## 1. Deploy the Ingress Controller

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

2. Save the public IP address of the Ingress controller into a shell variable:
```
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-annotations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Let's create a set of custom annotations to support [rate-limiting](https://ngin

## Prerequisites

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

## Step 1 - Customize the Template
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-templates/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Templates

The Ingress controller allows you to customize your templates through a [ConfigMap](../../docs/configmap-and-annotations.md) via the following keys:
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:
* `main-template` - Sets the main NGINX configuration template.
* `ingress-template` - Sets the Ingress NGINX configuration template for an Ingress resource.

Expand Down
2 changes: 1 addition & 1 deletion examples/customization/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Customization of NGINX Configuration

This example has been transformed into the [ConfigMap and Annotations doc](../../docs/configmap-and-annotations.md).
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.
2 changes: 1 addition & 1 deletion examples/daemon-set/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

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.

Read the installation instructions [here](../../docs/installation.md).
Read the installation instructions [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/).
2 changes: 1 addition & 1 deletion examples/externalname-services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ data:
resolver-addresses: "10.0.0.10"
```

Additional resolver parameters, including the caching of DNS records, are available. Check the corresponding [ConfigMap and Annotations](../../docs/configmap-and-annotations.md) section.
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.


## Example
Expand Down
2 changes: 1 addition & 1 deletion examples/grpc-services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To support a gRPC application with NGINX Ingress controllers, you need to add th

## Prerequisites

* HTTP/2 must be enabled. See `http2` ConfigMap key in the [ConfigMap and Annotations doc](../../docs/configmap-and-annotations.md).
* 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)
* Ingress resources for gRPC applications must include TLS termination.

## Syntax
Expand Down
2 changes: 1 addition & 1 deletion examples/mergeable-ingress-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ load balancing for that application using Ingress resources with the `nginx.org/

## 1. Deploy the Ingress Controller

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

2. Save the public IP address of the Ingress controller into a shell variable:
```
Expand Down
2 changes: 1 addition & 1 deletion examples/multiple-ingress-controllers/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Using Multiple Ingress Controllers

This example has been transformed into the [Multiple Ingress Controllers doc](../../docs/multiple-ingress-controllers.md).
This example has been transformed into the [Multiple Ingress Controllers doc](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/).
2 changes: 1 addition & 1 deletion examples/opentracing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this example we deploy the NGINX or NGINX Plus Ingress Controller and a simpl

## Prerequisites

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion examples/rbac/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# RBAC

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).
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/).
4 changes: 2 additions & 2 deletions examples/tcp-udp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Support for TCP/UDP Load Balancing

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).
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/).

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.

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

### 1. Deploy the Ingress Controller

1. Follow the installation [instructions](../../docs/installation.md) to deploy the Ingress controller. Make sure to expose port 5353 of the Ingress controller
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
both for TCP and UDP traffic.

2. Save the public IP address of the Ingress controller into a shell variable:
Expand Down
2 changes: 1 addition & 1 deletion examples/wildcard-tls-certificate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The wildcard TLS certificate simplifies the configuration of TLS termination if

### Prerequisites

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:
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:

```yaml
-wildcard-tls-secret=nginx-ingress/wildlcard-tls-secret
Expand Down