Services plug-in for Tanzu CLI

Caution: The former tanzu service types list and tanzu service instance list commands are now deprecated. They have been hidden from CLI output text but are still functional if invoked. Support for these commands ends either after two minor releases (v0.6.0) or after one year (2023-07-12), whichever occurs later. Use the alternative commands tanzu service class list and tanzu service claimable list instead.

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

The plug-in is currently distributed with Tanzu Application Platform. See Install or update the Tanzu CLI and plug-ins for information on how to acquire and install the plug-in.

Use cases

The Services plug-in for Tanzu CLI is currently of most use to the application developer and application operator roles. See Terminology and User Roles for more details. The following use cases are currently covered by the plug-in as documented below.

Discover service instance classes

Service instance classes can be discovered by running:

tanzu service classes list

For further information including help text and usage, run:

tanzu service classes list --help

Discover claimable service instances

Discover claimable service instance for a given class can be discovered by running:

tanzu service claimable list --class CLASS-NAME

Where CLASS-NAME is the name of a ClusterInstanceClass to discover claimable service instances from.

For further information including help text and usage, run:

tanzu service claimable list --help

Claim service instances with resource claims

Application operators 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

List and get 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

Unclaim service instances

Application operators 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