Red Hat Developer Hub 1.9

Troubleshooting Red Hat Developer Hub plugins

Troubleshooting RHDH plugins

Red Hat Customer Content Services

Abstract

You can troubleshoot common problems with Red Hat Developer Hub (RHDH) plugins, such as pod startup failures caused by missing plugin configuration.

1. Troubleshoot a pod startup failure after enabling a plugin

You can troubleshoot common problems with Red Hat Developer Hub (RHDH) plugins, such as pod startup failures caused by missing plugin configuration.

1. Troubleshoot a pod startup failure after enabling a plugin

If the RHDH pod fails to start after enabling a plugin, you can inspect the pod logs and configure the required environment variables.

Procedure

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"

Verify the required configuration by inspecting the 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}.

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

Mount the secret:
1. If you deployed RHDH by using the Operator, update your Backstage CR, as follows:
```
spec:
  application:
    extraEnvs:
      secrets:
        - name: rhdh-secrets
```
2. If you deployed RHDH 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
```

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.