General debugging

Begin debugging Gloo Portal by taking the following steps.

  1. Check that the gateway-portal-web-server is running.

      kubectl get pods -n gloo-system -l app=gateway-portal-web-server

  2. Check the logs of the Gloo Portal server.

      kubectl logs -n gloo-system deploy/gateway-portal-web-server

    Optionally, you can format the output with jq or save it in a local file so that you can read and analyze the output more easily.

      kubectl logs -n gloo-system deploy/gateway-portal-web-server > logs-gateway-portal-web-server.json

  3. Check the state of other Gloo components that the portal server interacts with, such as the gloo control plane, rate limiter, and external auth service. For more information, see the Debugging guide.

No status or automatically generated resources

You might notice that your Gloo Portal resources such as ApiDocs and ApiProducts do not have any status.

Resources that Gloo Portal creates for you might not show up, such as the following:

  • No ApiDoc after annotating a service with the necessary gloo.solo.io/scrape-openapi-* annotations for automatic discovery.
  • No ApiDoc with a stitched schema after creating a Portal resource.
  • No PortalConfig after creating a Portal resource.

To fix these issues, make sure that you fully enabled Gloo Portal in your setup.

  1. Get the Helm values of your current Helm release.

      helm get values gloo-gateway -n gloo-system -o yaml > gloo-gateway.yaml
open gloo-gateway.yaml

  2. Check the values to ensure the following settings.

    • You have an Enterprise license set.
    • You have the Gloo Portal plugin enabled, such as in the following section.
        
gloo:
  kubeGateway:
    portal:
      # Enables the Gloo Portal plugin, as well as installs the Helm subchart with the Portal CRDs and necessary RBAC settings.
      enabled: true
    • You have the portal server deployed, such as in the following section. Note that the default value is true. To be safe, explicitly set this value to true.
        
gateway-portal-web-server:
  glooPortalServer:
    enabled: true

  3. If necessary, update your settings and upgrade your Helm release.