Setting Up Enterprise PKS Admin Users on GCP
Page last updated:
Warning: Pivotal Container Service (PKS)
v1.5 is no longer supported because it has reached the End
of General Support (EOGS) phase as defined by the
Support Lifecycle Policy.
To stay up to date with the latest software and security updates, upgrade to a supported version.
This topic describes how to create admin users in Enterprise Pivotal Container Service (Enterprise PKS) with User Account and Authentication (UAA). Creating at least one admin user is a necessary step during the initial set up of Enterprise PKS.
UAA is the identity management service for Pivotal Cloud Foundry. Enterprise PKS includes a UAA server, which is hosted on the PKS control plane VM.
To interact with the UAA server, you can use the UAA Command Line Interface (UAAC). You can either run UAAC commands from the Ops Manager VM or install UAAC on your local workstation.
Before setting up admin users for Enterprise PKS, you must have one of the following:
SSH access to the Ops Manager VM
A machine that can connect to your PKS control plane VM
You can connect to the PKS control plane VM from the Ops Manager VM or from a different machine such as your local workstation.
You can connect to the PKS control plane VM by logging in to the Ops Manager VM through SSH. To SSH into the Ops Manager VM on GCP, do the following:
Confirm that you have installed the gcloud Command Line Interface (CLI). For more information, see Downloading gcloud in the Google Cloud Platform (GCP) documentation.
From the GCP console, click Compute Engine.
Locate the Ops Manager VM in the VM Instances list.
Click the SSH menu button.
Copy the SSH command that appears in the pop-up window.
SSH into the Ops Manager VM by pasting the command into your terminal. For example:
$ gcloud compute ssh om-pcf-1a --zone us-central1-b
Switch to the
ubuntuuser by running the
sudo su - ubuntucommand.
Proceed to the Log In as a UAA Admin section to manage users with UAAC.
To connect to the PKS control plane VM and run UAA commands, do the following:
Install UAAC on your machine. For example:
gem install cf-uaac
Download a copy of your Ops Manager root CA certificate to the machine. To download the certificate, do the following:
- In a web browser, navigate to the FQDN of Ops Manager and log in.
- In Ops Manager, navigate to Settings in the drop-down menu under your username.
- Click Advanced Options.
- On the Advanced Options configuration page, click Download Root CA Cert.
- Move the certificate to a secure location on your machine and record the path.
Proceed to the Log In as a UAA Admin section to create admin users with UAAC.
Before creating PKS admin users, you must log in to the UAA server as a UAA admin. To log in to the UAA server, do the following:
Retrieve the UAA management admin client secret:
- In a web browser, navigate to the Ops Manager Installation Dashboard and click the Enterprise PKS tile.
- Click the Credentials tab.
- Click Link to Credential next to Pks Uaa Management Admin Client and copy the value of
Target your UAA server by running the following command:
uaac target https://PKS-API:8443 --ca-cert CERTIFICATE-PATH
PKS-APIis the domain name of your PKS API server. You entered this domain name in the Enterprise PKS tile > PKS API > API Hostname (FQDN).
CERTIFICATE-PATHis the path to your Ops Manager root CA certificate. Provide this certificate to validate the PKS API certificate with SSL.
- If you are logged in to the Ops Manager VM, specify
/var/tempest/workspaces/default/root_ca_certificateas the path. This is the default location of the root certificate on the Ops Manager VM.
- If you downloaded the Ops Manager root CA certificate to your machine, specify the path where you stored the certificate.
- If you are logged in to the Ops Manager VM, specify
$ uaac target api.pks.example.com:8443 --ca-cert /var/tempest/workspaces/default/root_ca_certificate
Note: If you receive an
Unknown key: Max-Age = 86400warning message, you can ignore it because it has no impact.
Authenticate with UAA by running the following command:
uaac token client get admin -s ADMIN-CLIENT-SECRET
ADMIN-CLIENT-SECRETis your UAA management admin client secret that you retrieved in a previous step. The client username is
By assigning PKS cluster scopes, you grant users the ability to create and manage Kubernetes clusters in Enterprise PKS.
As a UAA admin user, you can assign the following UAA scopes:
pks.clusters.manage: Accounts with this scope can create and access their own clusters.
pks.clusters.admin: Accounts with this scope can create and access all clusters.
You can assign these scopes to individual users, external identity provider groups, or clients for automation purposes.
Based on the needs of your deployment, perform one or more of the following procedures:
- To assign PKS cluster scopes to an individual user, see Grant Enterprise PKS Access to an Individual User. Follow this procedure if you selected Internal UAA when you configured UAA in the Enterprise PKS tile. For more information, see Installing Enterprise PKS on GCP.
- To assign PKS cluster scopes to an LDAP group, see Grant Enterprise PKS Access to an External LDAP Group. Follow this procedure if you selected LDAP Server when you configured UAA in the Enterprise PKS tile. For more information, see Installing Enterprise PKS PKS on GCP.
- To assign PKS cluster scopes to a SAML group, see Grant Enterprise PKS Access to an External SAML Group. Follow this procedure if you selected SAML Identity Provider when you configured UAA in the Enterprise PKS tile. For more information, see Installing Enterprise PKS PKS on GCP.
- To assign PKS cluster scopes to a client, see Grant Enterprise PKS Access to a Client.
After you create admin users in Enterprise PKS, the admin users can create and manage Kubernetes clusters in Enterprise PKS. For more information, see Managing Kubernetes Clusters and Workloads.
Please send any feedback you have to email@example.com.