Services plug-in for Tanzu CLI

Warning: The services plug-in is currently in ALPHA. Commands and arguments might change without notice.

The services plug-in improves the user experience of working with services on Tanzu Application Platform. After installation, the plug-in is invoked by using the tanzu services command.

The plug-in is currently distributed with Tanzu Application Platform. Please see here for information on how to acquire and install the plug-in.

Use Cases

The services plug-in is currently of most use to the Application Developer and Application Operator roles. See User Roles for more details. The following use cases are currently covered by the plug-in as documented below.

Discovery of Service Types

Application Developers can discover the list of service types available on their target cluster by running:

tanzu service types list

For further information including help text and usage, run:

tanzu service types list --help

Listing Service Instances

Application Developers can list existing Service Instances on their target cluster by running:

tanzu Service Instances list

For further information including help text and usage, run:

tanzu Service Instances list --help

Claiming Service Instances with Resource Claims

Application Developers can claim Service Instances on their target cluster by running:

tanzu service claims create
CLAIM-NAME --resource-name SERVICE-INSTANCE-NAME --resource-kind SERVICE-INSTANCE-KIND --resource-api-version
SERVICE-INSTANCE-API-VERSION

Where:

  • CLAIM-NAME is the desired name of the Resource Claim to be created.
  • SERVICE-INSTANCE-NAME, SERVICE-INSTANCE-KIND and SERVICE-INSTANCE-API-VERSION are the name, kind and apiVersion, respectively, of the Service Instance to be claimed.
  • --resource-namespace is an optional flag that can be passed in with a namespace to claim a Service Instance in a different namespace.

For further information including help text and usage, run:

tanzu service claims create --help

Listing and getting Resource Claims

Application Developers can view existing claims on their target cluster by running:

tanzu service claims list

In addition, Application Developers can use this command to output Claim References by passing in -o wide, which can then be passed to the --service-ref flag of the tanzu apps workload create command in order to bind Application Workloads to Service Instances.

For further information including help text and usage, run:

tanzu service claims list --help

Unclaiming Service Instances

Application Developers can unclaim a claimed Service Instance on their target cluster by running:

tanzu service claims delete CLAIM-NAME

Where CLAIM-NAME is the name of the resource claim that currently claims the Service Instance.

For further information including help text and usage, run:

tanzu service claims delete --help
check-circle-line exclamation-circle-line close-line
Scroll to top icon