Skip to content
This repository was archived by the owner on May 24, 2023. It is now read-only.

Commit 55c51b9

Browse files
committed
Remove ingLink doc entry. Remove docstring note
1 parent 422da25 commit 55c51b9

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,8 @@ spec:
213213
description: 'Specifies the name of the IngressLink resource, which
214214
exposes the Ingress Controller pods via a BIG-IP system. The IP
215215
of the BIG-IP system is used when reporting the status of Ingress,
216-
VirtualServer and VirtualServerRoute resources. For Ingress resources
217-
only. Requires reportIngressStatus.enable set to true. Note: Only
218-
if serviceType is NodePort and reportIngressStatus.externalService
216+
VirtualServer and VirtualServerRoute resources. Requires reportIngressStatus.enable
217+
set to true. Note: Only if serviceType is NodePort and reportIngressStatus.externalService
219218
is not set.'
220219
type: string
221220
required:

docs/nginx-ingress-controller.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ spec:
6262
reportIngressStatus:
6363
enable: true
6464
externalService: my-nginx-ingress
65-
ingressLink: my-ingresslink
6665
prometheus:
6766
enable: true
6867
port: 9114
@@ -140,7 +139,7 @@ spec:
140139
| --- | --- | --- | --- |
141140
| `enable` | `boolean` | Enable reporting of the Ingress status. | Yes |
142141
| `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 |
143-
| `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. For Ingress resources only. Requires `reportIngressStatus.enable` set to `true`. Note: Only if ServiceType is `NodePort` and externalService is not set. | No |
142+
| `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 |
144143

145144
## NginxIngressController.Prometheus
146145

pkg/apis/k8s/v1alpha1/nginxingresscontroller_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ type ReportIngressStatus struct {
194194
ExternalService string `json:"externalService"`
195195
// Specifies the name of the IngressLink resource, which exposes the Ingress Controller pods via a BIG-IP system.
196196
// The IP of the BIG-IP system is used when reporting the status of Ingress, VirtualServer and VirtualServerRoute resources.
197-
// For Ingress resources only. Requires reportIngressStatus.enable set to true.
197+
// Requires reportIngressStatus.enable set to true.
198198
// Note: Only if serviceType is NodePort and reportIngressStatus.externalService is not set.
199199
// +kubebuilder:validation:Optional
200200
// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true

0 commit comments

Comments
 (0)