Chapter 5. Troubleshooting plugins

Procedure

1. Inspect your RHDH pod logs to identify if the plugin requires specific environment variables or additional configuration, for example:

   Plugin '<PLUGIN_NAME>' threw an error during startup, waiting for X other plugins to finish before shutting down the process. Plugin '<PLUGIN_NAME>' startup failed; caused by Error: Missing required config value at '<concretePluginRequiredVariable.name>' in 'app-config.local.yaml' type="initialization"

2. Verify the required configuration by inspecting dynamic-plugins.default.yaml file that lists the required environment variables for each plugin. The variables for each plugin are in the format of ${PLUGIN_VARIABLE_NAME}

3. If any required environment variables are missing, set the environment variables by using a secret. For example:

   kind: Secret
   apiVersion: v1
   metadata:
     name: rhdh-secrets
     labels:
       backstage.io/kubernetes-id: developer-hub
   data:
     PLUGIN_VARIABLE_NAME: 'dummy-value'
   type: Opaque

4. Mount the secret:

   1. If RHDH is deployed by using the Operator, update your Backstage CR, as follows:

      spec:
        application:
          extraEnvs:
            secrets:
              - name: rhdh-secrets

   2. If RHDH is deployed by using the Helm chart, in the upstream.backstage key in your Helm chart values, enter the name of the Developer Hub rhdh-secrets secret as the value for the extraEnvVarsSecrets field. For example:

      upstream:
        backstage:
          extraEnvVarsSecrets:
            - rhdh-secrets