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

Create ClassClaims

Given a ClusterInstanceClass, Application operators can claim service instances on their target cluster by running:

tanzu service class-claim create
CLAIM-NAME --class CLASS-NAME

Where:

• CLAIM-NAME is the desired name of the ClassClaim to be created.
• CLASS-NAME is the name of the ClusterInstanceClass to use to discover and claim a resource.

For further information including help text and usage, run:

tanzu service class-claim create --help

List and Get ClassClaims

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

tanzu service class-claim 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 class-claim list --help

To further interrogate the ClassClaim for details, run:

tanzu service class-claim get CLASS-NAME

Where CLAIM-NAME is the name of the ClassClaim that currently is claiming the service instance.

Delete ClassClaims

Application operators can unclaim a service instance, which was claimed via a ClassClaim, on their target cluster by running:

tanzu service class-claim delete CLAIM-NAME

Where CLAIM-NAME is the name of the ClassClaim that currently is claiming the service instance.

For further information including help text and usage, run:

tanzu service class-claims delete --help

Create ResourceClaims

Application operators can claim a specific service instances on their target cluster by running:

tanzu service resource-claim 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 resource-claim create --help

List and Get ResourceClaims

Application developers can view existing ResourceClaims on their target cluster by running:

tanzu service resource-claim 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 resource-claim list --help

To further interrogate the ResourceClaim for details, run:

tanzu service resource-claim get CLASS-NAME

Where CLAIM-NAME is the name of the ResourceClaim that currently is claiming the service instance.

Delete ResourceClaims

Application operators can unclaim a service instance on their target cluster by running:

tanzu service resource-claim delete CLAIM-NAME

Where CLAIM-NAME is the name of the ResourceClaim that currently claims the service instance.

For further information including help text and usage, run:

tanzu service resource-claim delete --help