Feature Overview (aka. Goal Summary)

Provide a consistent way how to collect and share information from a cluster, esp. for support caes.

Goals (aka. expected user outcomes)

A script or tool to collect important/necessary information from an RHDH installation to simplify and streamline support cases.

Requirements (aka. Acceptance Criteria):

A script or tool should collect at least this information:

1. Versions
   1. RHDH / Backstage version
      • might be the information from packages/app/src/build-metadata.json
      • RHIDP-4788 might introduce a second resource to override this information!
   2. Platform RHDH is running on (Openshift, AWS, GKE, etc.) if that's possible
   3. Perhaps underlying OS is of interest (RHEL I presume)?
   4. List of installed and enabled plugins with their versions
   5. NodeJS version
2. Configuration
   1. Maybe the complete Helm, Backstage CR or app-config configuration values in a way that we hide secrets?
   2. Or:
      1. Techdocs builder?
      2. VCS integrated (GitLab, GitHub, etc.)?
      3. Authentication provider?
      4. RBAC enabled/disabled?
3. Logs
   • Full log or maybe just the first 1k and last 1k lines of the container?

Out of Scope (Optional)

Showing this information to users / admins in the UI

Customer Considerations (Optional)

1. Customers should be aware of what kind of information we share.
2. They should have the option to not share some information like logs?
3. Sensitive information should be an opt-in? Like full app-config?

Documentation Considerations

1. This feature should be documented
2. This feature might influence support as well