Viewing Cluster Details

Page last updated:

Follow the steps below to view the details of an individual cluster using the PKS CLI.

  1. On the command line, run the following command to log in:

    pks login -a PKS-API -u USERNAME -k
    
    Where:

    • PKS-API is the domain name for the PKS API that you entered in Ops Manager > Enterprise PKS > PKS API > API Hostname (FQDN). For example, api.pks.example.com.
    • USERNAME is your user name.

      See Logging in to Enterprise PKS for more information about the pks login command.

      Note: If your operator has configured Enterprise PKS to use a SAML identity provider, you must include an additional SSO flag to use the above command. For information about the SSO flags, see the section for the above command in PKS CLI. For information about configuring SAML, see Configure SAML as an Identity Provider in the Installing topic for your IaaS.

  2. Run the following command to view the details of an individual cluster:

    pks cluster CLUSTER-NAME
    
    Replace CLUSTER-NAME with the unique name for your cluster. For example:
    $ pks cluster my-cluster

  3. Run the following command to view additional details of an individual cluster, including NSX-T network details and Kubernetes settings details:

    pks cluster CLUSTER-NAME --details
    
    Replace CLUSTER-NAME with the unique name for your cluster. For example:
    $ pks cluster my-cluster --details

The following shows the sample output for an example Kubernetes cluster named my-cluster:

$ pks cluster my-cluster --details
PKS Version:              1.5.0-build.30
Name:                     my-cluster
K8s Version:              1.14.5
Plan Name:                small
UUID:                     4b1a9b6d-3594-4cad-ad0f-22043fb26480
Last Action:              CREATE
Last Action State:        succeeded
Last Action Description:  Instance provisioning completed
Kubernetes Master Host:   example-hostname
Kubernetes Master Port:   8443
Worker Nodes:             3
Kubernetes Master IP(s):  10.197.100.130
Network Profile Name:

NSXT Network Details:
  Load Balancer Size                       (lb_size):                "small"
  Nodes DNS Setting                        (nodes_dns):              ["10.142.7.2"]
  Node IP addresses are routable [no-nat]  (node_routable):          false
  Nodes subnet prefix                      (node_subnet_prefix):     24
  POD IP addresses are routable [no-nat]   (pod_routable):           false
  PODs subnet prefix                       (pod_subnet_prefix):      24
  NS Group ID of master VMs                (master_vms_nsgroup_id):  ""
  Tier 0 Router identifier                 (t0_router_id):           "1e8371ac-1718-4617-8734-3975c6cd373b"
  Floating IP Pool identifiers             (fip_pool_ids):           ["901341c7-2e14-49d0-a3c1-66748664a062"]
  Node IP block identifiers                (node_ip_block_ids):      ["c5f0eb13-9691-4170-a9cd-c988f336ebd2"]
  POD IP block identifiers                 (pod_ip_block_ids):       ["fead2c9a-96e8-4c5f-98a3-e797f06bc8d4"]
Kubernetes Settings Details:
  Set by Plan:
  Kubelet Node Drain timeout (mins)          (kubelet-drain-timeout):            0
  Kubelet Node Drain grace-period (seconds)  (kubelet-drain-grace-period):       10
  Kubelet Node Drain force                   (kubelet-drain-force):              true
  Kubelet Node Drain force-node              (kubelet-drain-force-node):         false
  Kubelet Node Drain ignore-daemonsets       (kubelet-drain-ignore-daemonsets):  true
  Kubelet Node Drain delete-local-data       (kubelet-drain-delete-local-data):  true

Please send any feedback you have to pks-feedback@pivotal.io.