Page cover

service

The describe service command retrieves detailed information about a specific Service in the Kubernetes cluster. This includes metadata, service type, selector labels, exposed ports, target endpoints, and load balancing details.

Usage

cldkctl describe service [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 service [name]
  1. Replace [name] with the Service name you want to inspect.

  2. To view the resource name, refer to the corresponding get service 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 Service will appear in your terminal. The output includes metadata, type, selector labels, port configuration, and cluster IP details.

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

Column
Description

metadata.name

The name of the Service.

metadata.namespace

The namespace where the Service is deployed.

spec.type

The type of Service.

spec.selector

Defines the label selector used to match pods that the Service routes traffic to.

spec.ports

Lists the exposed ports for the Service, including port and target port mapping.

spec.ports.name

The logical name assigned to the port.

spec.ports.port

The port number exposed by the Service.

spec.ports.targetPort

The port number on the pod targeted by the Service.

spec.ports.protocol

The network protocol used by the Service.

spec.clusterIP

The internal IP address assigned to the Service within the cluster.

spec.clusterIPs

A list of cluster IPs associated with the Service.

spec.sessionAffinity

Defines how traffic from the same client is routed to the same pod

spec.ipFamilies

Indicates the IP address families supported by the Service

spec.ipFamilyPolicy

Specifies how dual-stack Service IP families are assigned.

spec.internalTrafficPolicy

Determines how internal cluster traffic is routed.

status.loadBalancer

Provides information about the external load balancer if applicable.

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 service command.

Last updated