Update docs

deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml

@@ -78,8 +78,9 @@ spec:
               description: Enables preview policies. Requires enableCRDs set to true.
               type: boolean
             enableSnippets:
-              description: Enable custom NGINX configuration snippets in VirtualServer
-                and VirtualServerRoute resources. Requires enableCRDs set to true.
+              description: Enable custom NGINX configuration snippets in VirtualServer,
+                VirtualServerRoute and TransportServer resources. Requires enableCRDs
+                set to true.
               type: boolean
             enableTLSPassthrough:
               description: Enable TLS Passthrough on port 443. Requires enableCRDs
@@ -209,15 +210,17 @@ spec:
                   description: 'Specifies the name of the service with the type LoadBalancer
                     through which the Ingress controller pods are exposed externally.
                     The external address of the service is used when reporting the
-                    status of Ingress resources. Note: Only if serviceType is NodePort.'
+                    status of Ingress resources. Note: if serviceType is LoadBalancer,
+                    the value of this field will be ignored, and the operator will
+                    use the name of the created LoadBalancer service instead.'
                   type: string
                 ingressLink:
                   description: 'Specifies the name of the IngressLink resource, which
                     exposes the Ingress Controller pods via a BIG-IP system. The IP
                     of the BIG-IP system is used when reporting the status of Ingress,
                     VirtualServer and VirtualServerRoute resources. Requires reportIngressStatus.enable
-                    set to true. Note: Only if serviceType is NodePort and reportIngressStatus.externalService
-                    is not set.'
+                    set to true. Note: If serviceType is LoadBalancer or reportIngressStatus.externalService
+                    is set, the value of this field will be ignored.'
                   type: string
               required:
               - enable

docs/nginx-ingress-controller.md

@@ -84,7 +84,7 @@ spec:
 | `defaultSecret` | `string` | The TLS Secret for TLS termination of the default server. The format is namespace/name. The secret must be of the type kubernetes.io/tls. If not specified, the operator will generate and deploy a TLS Secret with a self-signed certificate and key. | No |
 | `serviceType` | `string` | The type of the Service for the Ingress Controller. Valid Service types are `NodePort` or `LoadBalancer`. | Yes |
 | `enableCRDs` | `boolean` | Enables the use of NGINX Ingress Resource Definitions (VirtualServer and VirtualServerRoute). Default is `true`. | No |
-| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. Requires `enableCRDs` set to `true`. | No |
+| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. Requires `enableCRDs` set to `true`. | No |
 | `enablePreviewPolicies` | `boolean` | Enables preview policies. Requires `enableCRDs` set to `true`. | No |
 | `ingressClass` | `string` | A class of the Ingress controller. For Kubernetes >= 1.18, the Ingress controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. Additionally the Ingress Controller processes all the VirtualServer/VirtualServerRoute resources that do not have the "ingressClassName" field. For Kubernetes < 1.18, the Ingress Controller only processes resources that belong to its class - i.e have the annotation "kubernetes.io/ingress.class" (for Ingress resources) or field "ingressClassName" (for VirtualServer/VirtualServerRoute resources) equal to the class. Additionally, the Ingress Controller processes resources that do not have the class set, which can be disabled by setting `useIngressClassOnly` to `true`. Default is `nginx`. | No |
 | `service` | [service](#nginxingresscontrollerservice) | The service of the Ingress Controller. | No |
@@ -138,8 +138,8 @@ spec:
 | Field | Type | Description | Required |
 | --- | --- | --- | --- |
 | `enable` | `boolean` | Enable reporting of the Ingress status. | Yes |
-| `externalService` | `string` | Specifies the name of the service with the type LoadBalancer through which the Ingress controller pods are exposed externally. The external address of the service is used when reporting the status of Ingress resources. Note: Only if ServiceType is `NodePort`. | No |
-| `ingressLink` | `string` | Specifies the name of the IngressLink resource, which exposes the Ingress Controller pods via a BIG-IP system. The IP of the BIG-IP system is used when reporting the status of Ingress, VirtualServer and VirtualServerRoute resources. Requires `reportIngressStatus.enable` set to `true`. Note: Only if ServiceType is `NodePort` and externalService is not set. | No |
+| `externalService` | `string` | Specifies the name of the service with the type LoadBalancer through which the Ingress controller pods are exposed externally. The external address of the service is used when reporting the status of Ingress resources. Note: if `serviceType` is `LoadBalancer`, the value of this field will be ignored, and the operator will use the name of the created LoadBalancer service instead. | No |
+| `ingressLink` | `string` | Specifies the name of the IngressLink resource, which exposes the Ingress Controller pods via a BIG-IP system. The IP of the BIG-IP system is used when reporting the status of Ingress, VirtualServer and VirtualServerRoute resources. Requires `reportIngressStatus.enable` set to `true`. Note: If `serviceType` is `LoadBalancer` or `reportIngressStatus.externalService` is set, the value of this field will be ignored. | No |
 
 ## NginxIngressController.Prometheus
 

pkg/apis/k8s/v1alpha1/nginxingresscontroller_types.go

@@ -38,7 +38,7 @@ type NginxIngressControllerSpec struct {
 	// +nullable
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
 	EnableCRDs *bool `json:"enableCRDs"`
-	// Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
+	// Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
 	// Requires enableCRDs set to true.
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
@@ -192,13 +192,14 @@ type ReportIngressStatus struct {
 	Enable bool `json:"enable"`
 	// Specifies the name of the service with the type LoadBalancer through which the Ingress controller pods are exposed externally.
 	// The external address of the service is used when reporting the status of Ingress resources.
-	// Note: Only if serviceType is NodePort.
+	// Note: if serviceType is LoadBalancer, the value of this field will be ignored, and the operator will use the name of the created LoadBalancer service instead.
 	// +kubebuilder:validation:Optional
 	ExternalService string `json:"externalService"`
 	// Specifies the name of the IngressLink resource, which exposes the Ingress Controller pods via a BIG-IP system.
 	// The IP of the BIG-IP system is used when reporting the status of Ingress, VirtualServer and VirtualServerRoute resources.
 	// Requires reportIngressStatus.enable set to true.
-	// Note: Only if serviceType is NodePort and reportIngressStatus.externalService is not set.
+	// Note: If serviceType is LoadBalancer or reportIngressStatus.externalService is set, the value of this field
+	// will be ignored.
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
 	IngressLink string `json:"ingressLink,omitempty"`