Viewing Cluster Plans

Page last updated:

Follow the steps below to view information about the available plans for deploying a 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 Connecting Enterprise PKS to a SAML Identity Provider

2. Run the following command to view information about the available plans for deploying a cluster:

   $ pks plans

   The response lists details about the available plans, including plan names and descriptions:

   Name     ID  Description
   default      Default plan for K8s cluster