Pivotal Container Service v1.2

Managing PKS Deployments with BOSH

Page last updated:

This topic describes how to manage your Pivotal Container Service (PKS) deployment using BOSH.

Set a BOSH Environment Alias

To set a BOSH alias for your PKS deployment environment, follow the steps below:

  1. Gather credential and IP address information for your BOSH Director and SSH into the Ops Manager VM. See Advanced Troubleshooting with the BOSH CLI for more information.
  2. To create a BOSH alias for your PKS environment, run the following command:

    bosh alias-env ENVIRONMENT \
    -e BOSH-DIRECTOR-IP \
    --ca-cert /var/tempest/workspaces/default/root_ca_certificate
    Where:

    • ENVIRONMENT is an alias of your choice. For example, pks.
    • BOSH-DIRECTOR-IP is the BOSH Director IP address you located in the first step. For example, 10.0.0.3.

    For example:

    $ bosh alias-env pks -e 10.0.0.3 \
    --ca-cert /var/tempest/workspaces/default/root_ca_certificate

  3. To log in to the BOSH Director using the alias you set, run the following command:

    bosh -e ENVIRONMENT login

    For example:

    $ bosh -e pks login

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


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