LATEST VERSION: v1.3 - RELEASE NOTES
Pivotal Container Service v1.2

Diagnostic Tools

Verify PKS CLI Version

The Pivotal Container Service (PKS) CLI interacts with the your PKS deployment through the PKS API endpoint. You create, manage, and delete Kubernetes clusters on your PKS deployment by entering commands in the PKS CLI. The PKS CLI is under active development and commands may change between versions.

To determine the version of PKS CLI installed locally, run the following command:

pks --version

For example:

$ pks --version
PKS CLI version: 1.0.0-build.3

SSH into the PKS VM

To SSH into the PKS VM using BOSH, follow the steps below:

  1. Gather credential and IP address information for your BOSH Director, SSH into the Ops Manager VM, and use BOSH CLI to log in to the BOSH Director from the Ops Manager VM. For more information, see Advanced Troubleshooting with the BOSH CLI.

  2. To identify your PKS deployment’s name, run the following command:

    bosh -e ENVIRONMENT deployments

    Where ENVIRONMENT is the BOSH environment alias you set in Set a BOSH Environment Alias.

    For example:

    $ bosh -e pks deployments
    Your PKS deployment name begins with pivotal-container-service and includes a BOSH-generated hash.

  3. To identify your PKS VM’s name, run the following command:

    bosh -e ENVIRONMENT -d DEPLOYMENT vms

    Where:

    • ENVIRONMENT is the BOSH environment alias.
    • DEPLOYMENT is your PKS deployment name.

    For example:

    $ bosh -e pks -d pivotal-container-service/a1b2c333d444e5f66a77 vms

    Your PKS VM name begins with pivotal-container-service and includes a BOSH-generated hash.

    Note: The PKS VM hash value is different from the hash in your PKS deployment name.

  4. To SSH into the PKS VM, run the following command:

    bosh -e ENVIRONMENT -d DEPLOYMENT ssh PKS-VM

    Where:

    • ENVIRONMENT is the BOSH environment alias.
    • DEPLOYMENT is your PKS deployment name.
    • PKS-VM is your PKS VM name.

    For example:

    $ bosh -e pks \
    -d pivotal-container-service/a1b2c333d444e5f66a77 \
    ssh pivotal-container-service/000a1111-222b-3333-4cc5-de66f7a8899b

View Log Files

Log files contain error messages and other information you can use to diagnose issues with your PKS deployment. SSH into the PKS VM then follow the steps below to access PKS log files.

  1. To act as super user on the PKS VM, run the following command:

    sudo su

  2. To navigate to the PKS VM’s /var/vcap/sys/log log file directory, run the following command:

    cd /var/vcap/sys/log

  3. Examine the following files:

    • On the PKS master VM, examine the kube-apiserver log file.
    • On a PKS worker VM, examine the kubelet log file.

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

Create a pull request or raise an issue on the source for this page in GitHub