From c53cc5070665e77156e2996bcd22bbbbdeb8dc6b Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Tue, 28 Apr 2020 13:00:16 -0700 Subject: [PATCH] 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. --- README.md | 4 +++- .../cross-namespace-configuration.md | 4 ++-- .../installation/installation-with-manifests.md | 13 ++++--------- docs-web/overview.md | 2 ++ 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e2fe9e1eec..02c146778b 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,9 @@ NGINX Ingress controller works with both NGINX and NGINX Plus and supports the s 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. -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/). +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/). + +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/). Read [this doc](docs/nginx-plus.md) to learn more about NGINX Ingress controller with NGINX Plus. diff --git a/docs-web/configuration/ingress-resources/cross-namespace-configuration.md b/docs-web/configuration/ingress-resources/cross-namespace-configuration.md index 92c26e5523..064318215b 100644 --- a/docs-web/configuration/ingress-resources/cross-namespace-configuration.md +++ b/docs-web/configuration/ingress-resources/cross-namespace-configuration.md @@ -1,5 +1,5 @@ # Cross-namespace Configuration -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. +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. -See the [Mergeable Ingress Resources](https://github.com/nginxinc/kubernetes-ingress/tree/v1.7.0-rc1/examples/mergeable-ingress-types) example on our GitHub. +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. \ No newline at end of file diff --git a/docs-web/installation/installation-with-manifests.md b/docs-web/installation/installation-with-manifests.md index b61648529e..f6f733e574 100644 --- a/docs-web/installation/installation-with-manifests.md +++ b/docs-web/installation/installation-with-manifests.md @@ -41,16 +41,16 @@ In this section, we create resources common for most of the Ingress Controller i $ kubectl apply -f common/nginx-config.yaml ``` -1. Create custom resource definitions for [VirtualServer and VirtualServerRoute](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources) resources: +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: ``` $ kubectl apply -f common/vs-definition.yaml $ kubectl apply -f common/vsr-definition.yaml + $ kubectl apply -f common/ts-definition.yaml ``` -If you would like to use the TCP, UDP, and TLS Passthrough load balancing features of the Ingress Controller, create the following additional resources: -1. Create custom resource definitions for [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) and [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resources: +If you would like to use the TCP and UDP load balancing features of the Ingress Controller, create the following additional resources: +1. Create a custom resource definition for [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resource: ``` - $ kubectl apply -f common/ts-definition.yaml $ kubectl apply -f common/gc-definition.yaml ``` 1. Create a GlobalConfiguration resource: @@ -59,11 +59,6 @@ If you would like to use the TCP, UDP, and TLS Passthrough load balancing featur ``` **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. -If you would like to use only TLS Passthrough load balancing (without TCP and UDP), create only the custom resource definition for the TransportServer: -``` -$ kubectl apply -f common/ts-definition.yaml -``` - > **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. ## 3. Deploy the Ingress Controller diff --git a/docs-web/overview.md b/docs-web/overview.md index c7bb8ee135..daba126958 100644 --- a/docs-web/overview.md +++ b/docs-web/overview.md @@ -32,3 +32,5 @@ NGINX Ingress controller works with both NGINX and NGINX Plus and supports the s 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. 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). + +TCP, UDP and TLS Passthrough load balancing is also supported. See the [TransportServer resource doc](/nginx-ingress-controller/configuration/transportserver-resource/). \ No newline at end of file