Page cover

ingress

The describe ingress command retrieves detailed information about a specific Ingress resource in the Kubernetes cluster. This includes metadata, rules, associated services, TLS settings, annotations, and the current status of the Ingress controller.

Usage

cldkctl describe ingress [name] [flags]

Steps

Follow the steps below to run and view the result of this command:

  1. Run the following command in your terminal:

./cldkctl describe ingress [name] 
  1. Replace [name] with the Ingress name you want to inspect.

  2. To view the resource name, refer to the get ingress section.

  3. If the resource is located in a non-default namespace, include the -n or --namespace flag followed by the namespace name.

./cldkctl describe [resource] [name] -n [namespace]
  1. Once completed successfully, the detailed information about the specified Ingress will appear in your terminal. The output includes metadata, routing rules, backend services, and TLS configuration.

The following table describes the additional fields specific to the Ingress resource.

Column
Description

metadata.annotations

Displays additional configuration for the Ingress, such as NGINX rewrite rules or TLS settings.

spec.rules.host

The domain or hostname that this Ingress resource routes traffic for.

spec.rules.http.paths.path

The URL path matched by the rule.

spec.rules.http.paths.pathType

Determines how the path is matched.

spec.rules.http.paths.backend.service.name

The name of the Service that handles requests for the defined path.

spec.rules.http.paths.backend.service.port.number

The port number of the backend Service that receives incoming traffic.

status.loadBalancer

Displays load balancer-related information, such as assigned IP addresses or hostnames, once deployed.

Flags

  1. This command supports global flags. Refer to the Global Flags section for details.

  2. For common metadata fields, refer to the Common Output Fields table at the beginning of this section.

Flag
Description

-h, --help

Help for describe ingress command.

Last updated