Reporting resource status

This page describes how to view the status of resources managed by F5 NGINX Ingress Controller.

Ingress resources

An Ingress resource status includes the address (an IP address or a DNS name), through which the hosts of that Ingress resource are publicly accessible.

You can see the address in the output of the kubectl get ingress command, in the ADDRESS column, as shown below:

kubectl get ingresses

NAME           HOSTS              ADDRESS           PORTS     AGE
cafe-ingress   cafe.example.com   12.13.23.123      80, 443   2m

NGINX Ingress Controller must be configured to report an Ingress status:

1. Use the command-line flag -report-ingress-status.
2. Define a source for an external address. This can be either of:
   1. A user defined address, specified in the external-status-address ConfigMap key.
   2. A Service of the type LoadBalancer configured with an external IP or address and specified by the -external-service command-line flag.

View the ConfigMap keys and Command-line arguments topics for more information.

NGINX Ingress Controller does not clear the status of Ingress resources when it is being shut down.

VirtualServer and VirtualServerRoute resources

A VirtualServer or VirtualServerRoute resource includes the status field with information about the state of the resource and the IP address, through which the hosts of that resource are publicly accessible.

You can see the status in the output of the kubectl get virtualservers or kubectl get virtualserverroutes commands as shown below:

kubectl get virtualservers

  NAME   STATE   HOST                   IP            PORTS      AGE
  cafe   Valid   cafe.example.com       12.13.23.123  [80,443]   34s

To see an external hostname address associated with a VirtualServer resource, use the -o wide option:

kubectl get virtualservers -o wide

  NAME   STATE   HOST               IP    EXTERNALHOSTNAME                                                         PORTS      AGE
  cafe   Valid   cafe.example.com         ae430f41a1a0042908655abcdefghijkl-12345678.eu-west-2.elb.amazonaws.com   [80,443]   106s

If there are multiple addresses, only the first one is shown.

In order to see additional addresses or extra information about the Status of the resource, use the following command:

kubectl describe virtualserver <NAME>

...
Status:
  External Endpoints:
    Ip:        12.13.23.123
    Ports:     [80,443]
  Message:  Configuration for cafe/cafe was added or updated
  Reason:   AddedOrUpdated
  State:    Valid

Status specification

The following fields are reported in both VirtualServer and VirtualServerRoute status:

The ReferencedBy field is reported for the VirtualServerRoute status only:

externalEndpoint

NGINX Ingress Controller must be configured to report a VirtualServer or VirtualServerRoute status:

1. If you want NGINX Ingress Controller to report the externalEndpoints, define a source for an external address (The rest of the fields will be reported without the external address configured). This can be:
   1. A user defined address, specified in the external-status-address ConfigMap key.
   2. A Service of the type LoadBalancer configured with an external IP or address and specified by the -external-service command-line flag.

View the ConfigMap keys and Command-line arguments topics for more information.

NGINX Ingress Controller does not clear the status of VirtualServer and VirtualServerRoute resources when it is being shut down.

Policy resources

A Policy resource includes the status field with information about the state of the resource.

You can see the status in the output of the kubectl get policy command as shown below:

kubectl get policy

  NAME              STATE   AGE
  webapp-policy     Valid   30s

In order to see additional addresses or extra information about the Status of the resource, use the following command:

kubectl describe policy <NAME>

...
Status:
  Message:  Configuration for default/webapp-policy was added or updated
  Reason:   AddedOrUpdated
  State:    Valid

Status specification

The following fields are reported in Policy status:

TransportServer resources

A TransportServer resource includes the status field with information about the state of the resource.

You can see the status in the output of the kubectl get transportserver command as shown below:

kubectl get transportserver

  NAME      STATE   REASON           AGE
  dns-tcp   Valid   AddedOrUpdated   47m

To see additional addresses or extra information about the Status of the resource, use the following command:

kubectl describe transportserver <NAME>

Status:
  Message:  Configuration for default/dns-tcp was added or updated
  Reason:   AddedOrUpdated
  State:    Valid

Status specification

The following fields are reported in TransportServer status: