update docs

Signed-off-by: Haywood Shannon <[email protected]>

Signed-off-by: Haywood Shannon <[email protected]>

Author: haywoodsh

config/crd/bases/k8s.nginx.org_virtualserverroutes.yaml

@@ -1095,12 +1095,13 @@ spec:
                         ConfigMap key.
                       type: string
                     service:
-                      description: The name of a service. The service must belong
-                        to the same namespace as the resource. If the service doesn’t
-                        exist, NGINX will assume the service has zero endpoints and
-                        return a 502 response for requests for this upstream. For
-                        NGINX Plus only, services of type ExternalName are also supported
-                        .
+                      description: The name of a service. If the Service belongs to
+                        a different namespace than the VirtualServer or VirtualServerRoute,
+                        you need to include the namespace. For example, tea-namespace/tea.
+                        If the service doesn’t exist, NGINX will assume the service
+                        has zero endpoints and return a 502 response for requests
+                        for this upstream. For NGINX Plus only, services of type ExternalName
+                        are also supported in the same namespace.
                       type: string
                     sessionCookie:
                       description: The SessionCookie field configures session persistence

config/crd/bases/k8s.nginx.org_virtualservers.yaml

@@ -1284,12 +1284,13 @@ spec:
                         ConfigMap key.
                       type: string
                     service:
-                      description: The name of a service. The service must belong
-                        to the same namespace as the resource. If the service doesn’t
-                        exist, NGINX will assume the service has zero endpoints and
-                        return a 502 response for requests for this upstream. For
-                        NGINX Plus only, services of type ExternalName are also supported
-                        .
+                      description: The name of a service. If the Service belongs to
+                        a different namespace than the VirtualServer or VirtualServerRoute,
+                        you need to include the namespace. For example, tea-namespace/tea.
+                        If the service doesn’t exist, NGINX will assume the service
+                        has zero endpoints and return a 502 response for requests
+                        for this upstream. For NGINX Plus only, services of type ExternalName
+                        are also supported in the same namespace.
                       type: string
                     sessionCookie:
                       description: The SessionCookie field configures session persistence

deploy/crds.yaml

@@ -2133,12 +2133,13 @@ spec:
                         ConfigMap key.
                       type: string
                     service:
-                      description: The name of a service. The service must belong
-                        to the same namespace as the resource. If the service doesn’t
-                        exist, NGINX will assume the service has zero endpoints and
-                        return a 502 response for requests for this upstream. For
-                        NGINX Plus only, services of type ExternalName are also supported
-                        .
+                      description: The name of a service. If the Service belongs to
+                        a different namespace than the VirtualServer or VirtualServerRoute,
+                        you need to include the namespace. For example, tea-namespace/tea.
+                        If the service doesn’t exist, NGINX will assume the service
+                        has zero endpoints and return a 502 response for requests
+                        for this upstream. For NGINX Plus only, services of type ExternalName
+                        are also supported in the same namespace.
                       type: string
                     sessionCookie:
                       description: The SessionCookie field configures session persistence
@@ -3551,12 +3552,13 @@ spec:
                         ConfigMap key.
                       type: string
                     service:
-                      description: The name of a service. The service must belong
-                        to the same namespace as the resource. If the service doesn’t
-                        exist, NGINX will assume the service has zero endpoints and
-                        return a 502 response for requests for this upstream. For
-                        NGINX Plus only, services of type ExternalName are also supported
-                        .
+                      description: The name of a service. If the Service belongs to
+                        a different namespace than the VirtualServer or VirtualServerRoute,
+                        you need to include the namespace. For example, tea-namespace/tea.
+                        If the service doesn’t exist, NGINX will assume the service
+                        has zero endpoints and return a 502 response for requests
+                        for this upstream. For NGINX Plus only, services of type ExternalName
+                        are also supported in the same namespace.
                       type: string
                     sessionCookie:
                       description: The SessionCookie field configures session persistence

docs/crd/k8s.nginx.org_virtualserverroutes.md

@@ -209,7 +209,7 @@ The `.spec` object supports the following fields:
 | `upstreams[].queue.timeout` | `string` | The timeout of the queue. A request cannot be queued for a period longer than the timeout. The default is 60s. |
 | `upstreams[].read-timeout` | `string` | The timeout for reading a response from an upstream server. The default is specified in the proxy-read-timeout ConfigMap key. |
 | `upstreams[].send-timeout` | `string` | The timeout for transmitting a request to an upstream server. The default is specified in the proxy-send-timeout ConfigMap key. |
-| `upstreams[].service` | `string` | The name of a service. The service must belong to the same namespace as the resource. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported . |
+| `upstreams[].service` | `string` | The name of a service. If the Service belongs to a different namespace than the VirtualServer or VirtualServerRoute, you need to include the namespace. For example, tea-namespace/tea. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported in the same namespace. |
 | `upstreams[].sessionCookie` | `object` | The SessionCookie field configures session persistence which allows requests from the same client to be passed to the same upstream server. The information about the designated upstream server is passed in a session cookie generated by NGINX Plus. |
 | `upstreams[].sessionCookie.domain` | `string` | The domain for which the cookie is set. |
 | `upstreams[].sessionCookie.enable` | `boolean` | Enables session persistence with a session cookie for an upstream server. The default is false. |

docs/crd/k8s.nginx.org_virtualservers.md

@@ -244,7 +244,7 @@ The `.spec` object supports the following fields:
 | `upstreams[].queue.timeout` | `string` | The timeout of the queue. A request cannot be queued for a period longer than the timeout. The default is 60s. |
 | `upstreams[].read-timeout` | `string` | The timeout for reading a response from an upstream server. The default is specified in the proxy-read-timeout ConfigMap key. |
 | `upstreams[].send-timeout` | `string` | The timeout for transmitting a request to an upstream server. The default is specified in the proxy-send-timeout ConfigMap key. |
-| `upstreams[].service` | `string` | The name of a service. The service must belong to the same namespace as the resource. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported . |
+| `upstreams[].service` | `string` | The name of a service. If the Service belongs to a different namespace than the VirtualServer or VirtualServerRoute, you need to include the namespace. For example, tea-namespace/tea. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported in the same namespace. |
 | `upstreams[].sessionCookie` | `object` | The SessionCookie field configures session persistence which allows requests from the same client to be passed to the same upstream server. The information about the designated upstream server is passed in a session cookie generated by NGINX Plus. |
 | `upstreams[].sessionCookie.domain` | `string` | The domain for which the cookie is set. |
 | `upstreams[].sessionCookie.enable` | `boolean` | Enables session persistence with a session cookie for an upstream server. The default is false. |

pkg/apis/configuration/v1/types.go

@@ -119,7 +119,7 @@ type PolicyReference struct {
 type Upstream struct {
 	// The name of the upstream. Must be a valid DNS label as defined in RFC 1035. For example, hello and upstream-123 are valid. The name must be unique among all upstreams of the resource.
 	Name string `json:"name"`
-	// The name of a service. The service must belong to the same namespace as the resource. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported .
+	// The name of a service. If the Service belongs to a different namespace than the VirtualServer or VirtualServerRoute, you need to include the namespace. For example, tea-namespace/tea. If the service doesn’t exist, NGINX will assume the service has zero endpoints and return a 502 response for requests for this upstream. For NGINX Plus only, services of type ExternalName are also supported in the same namespace.
 	Service string `json:"service"`
 	// Selects the pods within the service using label keys and values. By default, all pods of the service are selected. Note: the specified labels are expected to be present in the pods when they are created. If the pod labels are updated, NGINX Ingress Controller will not see that change until the number of the pods is changed.
 	Subselector map[string]string `json:"subselector"`