Menu

Lumen help

Exploring the Tanzu Mission Control API

VMware Tanzu™ Mission Control provides Kubernetes cluster management capability on top of Lumen® Edge Private Cloud on VMware Cloud Foundation™. A Kubernetes cluster, a set of nodes that run containerized applications and services, provides a lightweight and flexible alternative to virtual machines.

In addition to using the VMware Tanzu Mission Control portal, you can manage Tanzu resources, features, and events through its application programming interface (API).

To view setup steps for the VMware Tanzu Mission Control API:

  1. Sign in to VMware Cloud Services.
  1. Click Services.

    VMware Cloud Services displays organization cards for My services and Other services.
  1. On the VMware Tanzu Mission Control card, click LAUNCH SERVICE.

    The VMware Tanzu Mission Control page displays.
  1. In the left panel, click Automation Center.

    The initialization steps for the API interface display.

Refer to the API Reference/Swagger documentation, which provides a library of API parameters and responses. You can import the VMware Tanzu Mission Control Swagger API parameters and calls into Postman, or a tool of your choice.

After you set up the VMware Tanzu Mission Control API, you can make direct API calls for Tanzu resources (such as list clusters, or show details of a cluster) through the Linux, or Mac OS command shell. The following section shows how to set up your API access using client URL (cURL). In addition, we provide API examples (using cURL).

To set up API access for VMware Tanzu Mission Control using cURL:

  1. Create a Cloud Services portal API access token (if not already created):

    1. Sign in to the VMware Cloud Services portal.
    2. Click User/Organization settings.
    3. In USER SETTINGS, click My Account, then API Tokens, then GENERATE TOKEN.
    4. Select a Token TTL (time-to-live), and a timeframe (minutes, hours, days, months, or never expires).
    5. Select the organization and service roles for the token.
    6. Select your email preferences.
    7. Click GENERATE.

      VMware Cloud Services displays your generated token.

    8. Click COPY.

      VMware Cloud Services copies your generated token to the clipboard.

Example set up -- in the Linux, or Apple OS terminal:

  1. Set your VMware Cloud Services portal API access token as your generated CSP_TOKEN:
                export CSP_TOKEN="<insert_token_here>"
  1. Set your VMware Cloud Services portal API access token as ACCESS_TOKEN.
                export ACCESS_TOKEN=$(curl -s -X POST https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize\?refresh_token\=$CSP_TOKEN | jq -r '.access_token')
  1. To verify your access, replace <YOUR_ORG> in the URL with the name of your org.
                curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" "https://<YOUR_ORG>.tmc.cloud.vmware.com/v1alpha1/clusters" | jq

API calls in VMware Tanzu Mission Control enable you to do the following:

  • List cluster groups
  • List clusters
  • Show details of a cluster
  • Show identity and access management (IAM) policies of a cluster

The following shows an example script using your API token in the Linux, or Apple OS terminal:

Note: This script is written in bash and expects the jq (json) and cURL commands to be pre-installed. You must edit the script to include your API token and VMware Tanzu Mission Control URL:

Replace <YOUR_API_TOKEN>

Replace <YOUR_ORG> 

                #!/bin/sh
 
# Get your refresh token from console.cloud.vmware.com
API_TOKEN="<YOUR_API_TOKEN>"
  
# Your API endpoint, if you are logged into the TMC UI it is the URL shown in your browser
API_ENDPOINT=https://<YOUR_ORG>.tmc.cloud.vmware.com
  
# Find the CSP endpoint
CSP_ENDPOINT=https://console.cloud.vmware.com
  
# Aquire access token from CSP
CSP_ACCESS_TOKEN=$(curl -sSX POST ${CSP_ENDPOINT}/csp/gateway/am/api/auth/api-tokens/authorize\?refresh_token\=${API_TOKEN} | jq -r .access_token)
 
# verify the token is working by listing all attached clusters
 
echo List of cluster groups
curl -sSX GET -H "Authorization: Bearer ${CSP_ACCESS_TOKEN}" ${API_ENDPOINT}/v1alpha1/clustergroups?searchScope.name=* | jq -r .clusterGroups[].fullName.name
echo
 
echo List of clusters
curl -sSX GET -H "Authorization: Bearer ${CSP_ACCESS_TOKEN}" ${API_ENDPOINT}/v1alpha1/clusters | jq -r .clusters[].fullName.name
echo
 
# Find name of first cluster
cluster_full_name=`curl -sSX GET -H "Authorization: Bearer ${CSP_ACCESS_TOKEN}" ${API_ENDPOINT}/v1alpha1/clusters | jq -r .clusters[0].fullName`
echo First cluster is: $cluster_full_name
echo
 
cluster_name=$(echo $cluster_full_name | jq -r .name)
cluster_management_cluster_name=$(echo $cluster_full_name | jq -r .managementClusterName)
cluster_provisioner_name=$(echo $cluster_full_name | jq -r .provisionerName)
 
# Show details of first cluster
curl -sSX GET -H "Authorization: Bearer ${CSP_ACCESS_TOKEN}" "${API_ENDPOINT}/v1alpha1/clusters/${cluster_name}?full_name.managementClusterName=${cluster_management_cluster_name}&full_name.provisionerName=${cluster_provisioner_name}" | jq .
echo
 
# Show IAM policies for first cluster
curl -sSX GET -H "Authorization: Bearer ${CSP_ACCESS_TOKEN}" "${API_ENDPOINT}/v1alpha1/clusters:iam/${cluster_name}?full_name.managementClusterName=${cluster_management_cluster_name}&full_name.provisionerName=${cluster_provisioner_name}" | jq .