Troubleshoot Tanzu Application Platform GUI

This topic describes troubleshooting information for problems with installing Tanzu Application Platform GUI.

Tanzu Application Platform GUI does not work in Safari

Symptom

Tanzu Application Platform GUI does not work in the Safari web browser.

Solution

Currently there is no way to use Tanzu Application Platform GUI in Safari. Please use a different web browser.

Catalog not found

Symptom

When you pull up Tanzu Application Platform GUI, you get the error Catalog Not Found.

Cause

The catalog plug-in can’t read the Git location of your catalog definition files.

Solution

  1. Ensure you have built your own Backstage-compatible catalog or that you have downloaded one of the Tanzu Application Platform GUI catalogs from VMware Tanzu Network.
  2. Ensure you defined the catalog in the values file that you input as part of installation. To update this location, change the definition file:

    • Change the Tanzu Application Platform profile file if installed by using a profile.
    • Change the standalone Tanzu Application Platform GUI values file if you’re only installing that package on its own.
        namespace: tap-gui
        service_type: SERVICE-TYPE
        app_config:
          catalog:
            locations:
              - type: url
                target: https://GIT-CATALOG-URL/catalog-info.yaml
    
  3. Provide the proper integration information for the Git location you specified earlier.

        namespace: tap-gui
        service_type: SERVICE-TYPE
        app_config:
          app:
            baseUrl: https://EXTERNAL-IP:PORT
          integrations:
            gitlab: # Other integrations available
              - host: GITLAB-HOST
                apiBaseUrl: https://GITLAB-URL/api/v4
                token: GITLAB-TOKEN
    

You can substitute for other integrations as defined in the Backstage documentation.

Issues updating the values file

Symptom

After updating the configuration of Tanzu Application Platform GUI, either by using a profile or as a standalone package installation, you don’t know whether the configuration has reloaded.

Solution

  1. Get the name you need by running:

    kubectl get pods -n tap-gui
    

    For example:

    $ kubectl get pods -n tap-gui
    NAME                      READY   STATUS    RESTARTS   AGE
    server-6b9ff657bd-hllq9   1/1     Running   0          13m
    
  2. Read the log of the pod to see if the configuration reloaded by running:

    kubectl logs NAME -n tap-gui
    

    Where NAME is the value you recorded earlier, such as server-6b9ff657bd-hllq9.

  3. Search for a line similar to this one:

    2021-10-29T15:08:49.725Z backstage info Reloaded config from app-config.yaml, app-config.yaml
    
  4. If need be, delete and re-instantiate the pod.

    Caution: Depending on your database configuration, deleting, and re-instantiating the pod might cause the loss of user preferences and manually registered entities. If you have configured an external PostgreSQL database, tap-gui pods are not stateful. In most cases, state is held in ConfigMaps, Secrets, or the database. For more information, see Configuring the Tanzu Application Platform GUI database and Register components.

    To delete and re-instantiate the pod, run:

    kubectl delete pod -l app=backstage -n tap-gui
    

Pull logs from Tanzu Application Platform GUI

Symptom

You have a problem with Tanzu Application Platform GUI, such as Catalog: Not Found, and don’t have enough information to diagnose it.

Solution

Get timestamped logs from the running pod and review the logs:

  1. Pull the logs by using the pod label by running:

    kubectl logs -l app=backstage -n tap-gui
    
  2. Review the logs.

Runtime Resources tab

Here are some common troubleshooting steps for errors presented in the Runtime Resources tab.

Error communicating with Tanzu Application Platform web server

Symptom

When accessing the Runtime Resource Visibility tab, the system displays Error communicating with TAP GUI back end.

Causes

  • An interrupted Internet connection
  • Error with the back end service

Solution

  1. Confirm that you have Internet access.
  2. Confirm that the back-end service is running correctly.
  3. Confirm the cluster configuration is correct.

No data available

Symptom

When accessing the Runtime Resource Visibility tab, the system displays One or more resources are missing. This could be due to a label mismatch. Please make sure your resources have the label(s) "LABEL_SELECTOR".

Cause

No communications error has occurred, but no resources were found.

Solution

Confirm that you are using the correct label:

  1. Verify the Component definition includes the annotation backstage.io/kubernetes-label-selector.

  2. Confirm your Kubernetes resources correspond to that label drop-down menu.

Errors retrieving resources

Symptom

When opening the Runtime Resource Visibility tab, the system displays One or more resources might be missing because of cluster query errors.

The reported errors might not indicate a real problem. A build cluster might not have runtime CRDs installed, such as Knative Service, and a run cluster might not have build CRDs installed, such as a Cartographer workload. In these cases, 403 and 404 errors might be false positives.

You might receive the following error messages:

  • Access error when querying cluster CLUSTER_NAME for resource KUBERNETES_RESOURCE_PATH (status: 401). Contact your administrator.

    • Cause: There is a problem with the cluster configuration.
    • Solution: Confirm the access token used to request information in the cluster.
  • Access error when querying cluster CLUSTER_NAME for resource KUBERNETES_RESOURCE_PATH (status: 403). Contact your administrator.

    • Cause: The service account used doesn’t have access to the specific resource type in the cluster.
    • Solution: If the cluster is the same where Tanzu Application Platform is running, review the version installed to confirm it contains the desired resource. If the error is in a watched cluster, review the process to grant access to it in Viewing resources on multiple clusters in Tanzu Application Platform GUI.
  • Knative is not installed on CLUSTER_NAME (status: 404). Contact your administrator.

    • Cause: The cluster does not have Cloud Native Runtimes installed.
    • Solution: Install the Knative components by following the instructions in Install Cloud Native Runtimes.
  • Error when querying cluster CLUSTER_NAME for resource KUBERNETES_RESOURCE_PATH (status: 404). Contact your administrator.

    • Cause: The package that contains the resource is not installed.
    • Solution: Install the missing package.

Accelerators page

Here are some common troubleshooting steps for errors displayed on the Accelerators page.

No accelerators

Symptom

When the app_config.backend.reading.allow section is configured in the tap-values.yaml file during the tap-gui package installation, there are no accelerators on the Accelerators page.

Cause

This section in tap-values.yaml overrides the default configuration that gives Tanzu Application Platform GUI access to the accelerators.

Solution

As a workaround, provide a value for Application Accelerator in this section. For example:

app_config:
  # Existing tap-values yaml above
  backend:
    reading:
      allow:
      - host: acc-server.accelerator-system.svc.cluster.local
check-circle-line exclamation-circle-line close-line
Scroll to top icon