Skip to content

Commit c53cc50

Browse files
committed
Improve docs
* The docs for manifests installation assume that it is not required to deploy the TS CRD. That assumption is wrong. The commit fixes that. * Mention TCP, UDP and TLS Passthrough load balancing in the README and the overview doc * Mention VS/VSR in the cross-namespace Ingress doc.
1 parent a2be36f commit c53cc50

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ NGINX Ingress controller works with both NGINX and NGINX Plus and supports the s
3131

3232
Additionally, several NGINX and NGINX Plus features are available as extensions to the Ingress resource via annotations and the ConfigMap resource. In addition to HTTP, NGINX Ingress controller supports load balancing Websocket, gRPC, TCP and UDP applications. See [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/) docs to learn more about the supported features and customization options.
3333

34-
As an alternative to the Ingress, NGINX Ingress controller supports the VirtualServer and VirtualServerRoute resources. They enable use cases not supported with the Ingress resource, such as traffic splitting and advanced content-based routing. See [VirtualServer and VirtualServerRoute Resources doc](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/).
34+
As an alternative to the Ingress, NGINX Ingress controller supports the VirtualServer and VirtualServerRoute resources. They enable use cases not supported with the Ingress resource, such as traffic splitting and advanced content-based routing. See [VirtualServer and VirtualServerRoute resources doc](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/).
35+
36+
TCP, UDP and TLS Passthrough load balancing is also supported. See the [TransportServer resource doc](https://docs.nginx.com/nginx-ingress-controller/configuration/transportserver-resource/).
3537

3638
Read [this doc](docs/nginx-plus.md) to learn more about NGINX Ingress controller with NGINX Plus.
3739

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Cross-namespace Configuration
22

3-
You can spread the Ingress configuration for a common host across multiple Ingress resources using Mergeable Ingress resources. Such resources can belong to the *same* or *different* namespaces. This enables easier management when using a large number of paths.
3+
You can spread the Ingress configuration for a common host across multiple Ingress resources using Mergeable Ingress resources. Such resources can belong to the *same* or *different* namespaces. This enables easier management when using a large number of paths. See the [Mergeable Ingress Resources](https://github.com/nginxinc/kubernetes-ingress/tree/v1.7.0/examples/mergeable-ingress-types) example on our GitHub.
44

5-
See the [Mergeable Ingress Resources](https://github.com/nginxinc/kubernetes-ingress/tree/v1.7.0-rc1/examples/mergeable-ingress-types) example on our GitHub.
5+
As an alternative to Mergeable Ingress resources, you can use [VirtualServer and VirtualServerRoute resources](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) for cross-namespace configuration. See the [Cross-Namespace Configuration](https://github.com/nginxinc/kubernetes-ingress/tree/v1.7.0/examples-of-custom-resources/cross-namespace-configuration) example on our GitHub.

docs-web/installation/installation-with-manifests.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ In this section, we create resources common for most of the Ingress Controller i
4141
$ kubectl apply -f common/nginx-config.yaml
4242
```
4343
44-
1. Create custom resource definitions for [VirtualServer and VirtualServerRoute](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources) resources:
44+
1. Create custom resource definitions for [VirtualServer and VirtualServerRoute](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources) and [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) resources:
4545
```
4646
$ kubectl apply -f common/vs-definition.yaml
4747
$ kubectl apply -f common/vsr-definition.yaml
48+
$ kubectl apply -f common/ts-definition.yaml
4849
```
4950
50-
If you would like to use the TCP, UDP, and TLS Passthrough load balancing features of the Ingress Controller, create the following additional resources:
51-
1. Create custom resource definitions for [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) and [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resources:
51+
If you would like to use the TCP and UDP load balancing features of the Ingress Controller, create the following additional resources:
52+
1. Create a custom resource definition for [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resource:
5253
```
53-
$ kubectl apply -f common/ts-definition.yaml
5454
$ kubectl apply -f common/gc-definition.yaml
5555
```
5656
1. Create a GlobalConfiguration resource:
@@ -59,11 +59,6 @@ If you would like to use the TCP, UDP, and TLS Passthrough load balancing featur
5959
```
6060
**Note**: Make sure to references this resource in the [`-global-configuration`](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments#cmdoption-global-configuration) command-line argument.
6161
62-
If you would like to use only TLS Passthrough load balancing (without TCP and UDP), create only the custom resource definition for the TransportServer:
63-
```
64-
$ kubectl apply -f common/ts-definition.yaml
65-
```
66-
6762
> **Feature Status**: The TransportServer and GlobalConfiguration resources are available as a preview feature: it is suitable for experimenting and testing; however, it must be used with caution in production environments. Additionally, while the feature is in preview, we might introduce some backward-incompatible changes to the resources specification in the next releases.
6863
6964
## 3. Deploy the Ingress Controller

docs-web/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,5 @@ NGINX Ingress controller works with both NGINX and NGINX Plus and supports the s
3232
Additionally, several NGINX and NGINX Plus features are available as extensions to the Ingress resource via annotations and the ConfigMap resource. In addition to HTTP, NGINX Ingress controller supports load balancing Websocket, gRPC, TCP and UDP applications. See [ConfigMap](/nginx-ingress-controller/configuration/global-configuration/configmap-resource) and [Annotations](/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations) docs to learn more about the supported features and customization options.
3333

3434
As an alternative to the Ingress, NGINX Ingress controller supports the VirtualServer and VirtualServerRoute resources. They enable use cases not supported with the Ingress resource, such as traffic splitting and advanced content-based routing. See [VirtualServer and VirtualServerRoute Resources doc](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources).
35+
36+
TCP, UDP and TLS Passthrough load balancing is also supported. See the [TransportServer resource doc](/nginx-ingress-controller/configuration/transportserver-resource/).

0 commit comments

Comments
 (0)