Troubleshoot Services Toolkit

This topic explains how you can troubleshoot issues related to working with services on Tanzu Application Platform (commonly known as TAP).

For the limitations of services on Tanzu Application Platform, see Services Toolkit limitations.

Debug `ClassClaim` and provisioner-based `ClusterInstanceClass`

This section provides guidance on how to debug issues related to using ClassClaim and provisioner-based ClusterInstanceClass. The approach starts by inspecting a ClassClaim and tracing back through the chain of resources that are created when fulfilling the ClassClaim.

Prerequisites

To follow the steps in this section, you must have kubectl access to the cluster.

Step 1: Inspect the `ClassClaim`, `ClusterInstanceClass`, and `CompositeResourceDefinition`

Inspect the status of ClassClaim by running:
```
kubectl describe classclaim claim-name -n NAMESPACE
```
Where NAMESPACE is your namespace.

From the output, check the following:
- Check the status conditions for information that can lead you to the cause of the issue.
- Check .spec.classRef.name and record the value.
Inspect the status of the ClusterInstanceClass by running:
```
kubectl describe clusterinstanceclass CLASS-NAME
```
Where CLASS-NAME is the value of .spec.classRef.name you retrieved in the previous step.

From the output, check the following:
- Check the status conditions for information that can lead you to the cause of the issue.
- Check that the Ready condition has status "True".
- Check .spec.provisioner.crossplane and record the value.
Inspect the status of the CompositeResourceDefinition by running:
```
kubectl describe xrd XRD-NAME
```
Where XRD-NAME is the value of .spec.provisioner.crossplane you retrieved in the previous step.

From the output, check the following:
- Check the status conditions for information that can lead you to the cause of the issue.
- Check that the Established condition has status "True".
- Check events for any errors or warnings that can lead you to the cause of the issue.
- If both the ClusterInstanceClass reports Ready="True" and the CompositeResourceDefinition reports Established="True", move on to the next section.

Step 2: Inspect the Composite Resource, the Managed Resources and the underlying resources

Check .status.provisionedResourceRef by running:
```
kubectl describe classclaim claim-name -n NAMESPACE
```
Where NAMESPACE is your namespace.

From the output, check the following:
- Check .status.provisionedResourceRef, and record the values of kind, apiVersion, and name.
Inspect the status of the Composite Resource by running:
```
kubectl describe KIND.API-GROUP NAME
```
Where:
- KIND is the value of kind you retrieved in the previous step.
- API-GROUP is the value of apiVersion you retrieved in the previous step without the /<version> part.
- NAME is the value of name you retrieved in the previous step.
From the output, check the following:
- Check the status conditions for information that can lead you to the cause of the issue.
- Check that the Synced condition has status "True". If it doesn’t then there was an issue creating the Managed Resources from which this Composite Resource is composed. Refer to .spec.resourceRefs in the output and for each:
  - Use the values of kind, apiVersion, and name to inspect the status of the Managed Resource.
  - Check the status conditions for information that can lead you to the cause of the issue.
- Check events for any errors or warnings that can lead you to the cause of the issue.
- If all Managed Resources appear healthy, move on to the next section.

Step 3: Inspect the events log

Inspect the events log by running:

kubectl get events -A

From the output, check the following:

Check for any errors or warnings that can lead you to the cause of the issue.
If there are no errors or warnings, move on to the next section.

Step 4: Inspect the secret

Check .status.resourceRef by running:
```
kubectl get classclaim claim-name -n NAMESPACE -o yaml
```
Where NAMESPACE is your namespace.

From the output, check the following:
- Check .status.resourceRef and record the values kind, apiVersion, name, and namespace
Inspect the claimed resource, which is likely a secret, by running:
```
kubectl get secret NAME -n NAMESPACE -o yaml
```
Where:
- NAME is the name you retrieved in the previous step.
- NAMESPACE is the namespace you retrieved in the previous step.
If the secret is there and has data, then something else must be causing the issue.

Step 5: Contact support

If you have followed the steps in this section and are still unable to discover the cause of the issue, contact VMware Support for further guidance and help to resolve the issue.

Unexpected error if `additionalProperties` is `true` in a CompositeResourceDefinition

Symptom:

When creating a CompositeResourceDefinition, if you set additionalProperties: true in the openAPIV3Schema section, an error occurs during the validation step of the creation of any ClassClaim that refers to a class that refers to the CompositeResourceDefinitions.

The error appears as follows:

json: cannot unmarshal bool into Go struct field JSONSchemaProps.AdditionalProperties of type apiextensions.JSONSchemaPropsOrBool

Solution:

Rather than setting additionalProperties: true, you can set additionalProperties: {}. This has the same effect, but does not cause unexpected errors.

Cannot claim from clusterinstanceclass when creating a `ClassClaim`

Symptom:

Users who were previously able to create a ClassClaim now get an admission error similar to:

user '[email protected]' cannot 'claim' from clusterinstanceclass 'bigcorp-rabbitmq'

This occurs even if users were granted the claim permission on ClusterInstanceClasses through either:

A Role and a RoleBinding
A ClusterRole and a RoleBinding

Explanation:

You now need the cluster-level claim permission, granted through a ClusterRole and ClusterRoleBinding. Namespace-scoped permissions are no longer enough. This is to protect against unexpected access to resources in other namespaces.

This change was introduced with Services Toolkit v0.11.1 in Tanzu Application Platform v1.6.4. For more information about this change, see The claim verb for ClusterInstanceClass.

Solution:

To allow users to create ClassClaims again, you must:

Move from a Role to a ClusterRole for granting users permission to claim a ClusterInstanceClass.
Move from a RoleBinding to a ClusterRoleBinding for binding this permission to a user.

For more information, see Authorize users and groups to claim from provisioner-based classes.