Procedure

1. Navigate to the RHDH URL provided by your administrator.
2. On the login page, select the appropriate authentication method configured for your environment:
3. Enterprise authentication: Log in with your corporate credentials, such as Single Sign-On or Keycloak.
4. OAuth provider: Select an external provider, such as GitHub or GitLab, if your organization manages developer identities through those services.

5. Guest access: If available, select Enter as Guest for read-only exploration.

   Note

   Guest access has limited permissions. You cannot create or register components with guest access. Production environments typically disable guest access for security. To perform these actions, you must use an authenticated account with the required permissions.

6. Enter your credentials and complete the required authentication prompts.

Verification

1. The portal redirects you to the Home page.

1. The system displays your personalized dashboard, showing your username and recently accessed items.

Procedure

1. Log in to the RHDH interface.
2. In the navigation sidebar, click Catalog.
3. Click the Kind filter and select Component.
4. Optional: Click the Type filter to select a functional category, such as Library, Website, or Tool.
5. In the Search field, enter the name of the component.
6. Select the component card to view the Overview, Docs, and Relationships tabs.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Click the Kind filter and select Component.
4. Click the Type filter and select Service.
5. Optional: Narrow the list by selecting a specific Owner or Lifecycle, such as production or experimental.
6. Select a service card to open the detailed entity view.
7. Review the Overview tab to identify the assigned owner and access links to the source code repository.
8. Select the Dependencies or Relations tab to see upstream and downstream connections for that service.

Procedure

1. Navigate to the RHDH interface.

2. In the left navigation sidebar, click APIs.

   Note

   You can also find these resources by clicking Catalog and selecting API from the Kind filter.

3. Select an API from the list to open the detail view.
4. Select the Overview tab to examine the metadata, assigned owner, and lifecycle status.

5. Select the Definition tab to view the rendered specification, such as an interactive Swagger or AsyncAPI interface.

   Note

   To test APIs in the RHDH interface before writing a single line of code, you must correctly configure the API definition.

Procedure

1. On the Red Hat Developer Hub navigation menu, click Catalog > Self-service or in the Global Header, click Create (+).
2. On the Self-service page, locate the Templates you want to use and click Choose to start the scaffolding process.
3. Follow the wizard instructions to enter the required project details.

4. In the Review step, verify your parameters and click Create.

   The scaffolding process begins. You can monitor the progress in the logs or click Cancel to stop the operation.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Catalog > Self-service.
2. In the Search field, enter the name for the Software Template.
3. Optional: To refine the results, select a category from the Category list.

Procedure

1. Open your RHDH app-config.yaml configuration file.

2. In the catalog.rules section, add a rule to allow Templates kinds, as shown in the following example:

   # ...
   catalog:
     rules:
       - allow: [Template]
     locations:
       - type: url
         target: https://<repository_url/template-name>.yaml
   # ...

   where:

   catalog.rules.allow

   Specify the Template rule to allow new Software Templates in the catalog.

   catalog.locations.type

   Specify the url type when importing templates from a repository (for example, GitHub or GitLab).

   catalog.locations.target

   Specify the full URL to the template file.

Verification

1. In the Red Hat Developer Hub navigation menu, click Catalog.
2. From the Kind list, select Template.
3. Verify that the Template list displays your template.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Docs.

2. On the Documentation page, use the Search bar or filters to locate your document:

   • Search: Enter keywords to find specific terms within documents.
   • Filter by Owner: View documents owned by specific users or groups.
   • Filter by Tags: Narrow results by specific labels or categories.
   • Filter by Owned: View documents belonging to you or your group.

   • Filter by Starred: View your bookmarked favorites.

     The results update automatically to show the number of documents that meet your criteria.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Docs.
2. In the Documentation table, click the name of the document you want to view.

3. Navigate the content using the following on-screen tools:

   • Search bar: Find keywords within the current document.
   • Table of contents: Jump to specific sections.
   • Navigation menu: Switch between different documents in the same book.
   • Next: Proceed to the next sequential document.
   • Add-ons: Perform additional actions if the system configures plugins, such as setting the text size.

Procedure

1. Navigate to the specific API you must validate and select the Definition tab.
2. Locate the operation you want to verify and select the header to expand the details.
3. Click Try it out to enable the interactive input fields.
4. Enter the required parameters or the request body JSON in the provided fields.
5. Click Run.

6. Examine the Server response section to verify the status code, response body, and headers.

   Note

   If you receive 401 (Unauthorized) or 403 (Forbidden) errors, you must verify your credentials with the API owner or check the authorization header requirements in the specification.

Procedure

1. Click the Search input field in the Global Header.
2. Enter your query, such as a service name, API endpoint, or technical concept.
3. Review the instant results in the dropdown menu, which categorize matches by entity types such as Components, APIs, TechDocs, and Users.
4. Select a suggestion from the list to navigate directly to that resource.

Procedure

1. Enter a search term in the Search bar.
2. Click All results…​.
3. In the Filters panel, select one or more of the following options:
4. Kind: Filters by entity category, such as Component, API, Template, or Group.
5. Type: Narrows the results by functional subtype, such as service, library, or website.
6. Lifecycle: Isolates resources by operational status, such as production, experimental, or deprecated.
7. Review the filtered results to identify the resource description and owner.
8. Optional: Use the pagination controls to navigate the results.

Procedure

1. To enable query validation, add the following keys to the Secret that LCORE reads:

   stringData:
     ENABLE_VALIDATION: question_validity
     VALIDATION_PROVIDER: <provider_type>
     VALIDATION_MODEL_NAME: <model_name>

   where:

   ENABLE_VALIDATION

   Specifies whether the shield is enabled. You must set the value to question_validity. A nonempty value such as true does not enable the shield in RHDH 2.1.

   VALIDATION_PROVIDER

   Specifies the type of the inference provider that runs the classification, for example, openai or vllm. A provider of this type must be enabled in inference.providers.

   VALIDATION_MODEL_NAME

   Specifies the model that classifies each prompt. If the provider defines allowed_models, include this model in that list.

   For example, to run classification on an openai provider with the gpt-4o-mini model, set the following values:

   stringData:
     ENABLE_VALIDATION: question_validity
     VALIDATION_PROVIDER: openai
     VALIDATION_MODEL_NAME: gpt-4o-mini

2. To keep query validation disabled, leave ENABLE_VALIDATION unset, or set it to disabled:

   stringData:
     ENABLE_VALIDATION: __disabled__

   Important

   Running without query validation increases the risk of off-topic or harmful model output. Disable validation only in secure development environments.

3. Apply the updated Secret, and then restart the LCORE service so that the container reads the new environment variables.

Verification

1. Open the Intelligent Assistant and submit a development question, for example, How do I create a software template in RHDH?. Confirm that the assistant answers the question.
2. Submit a clearly unrelated question, for example, What is a good recipe for pizza?. Confirm that the assistant rejects the question when validation is enabled.

Procedure

1. In the lightspeed-stack.yaml file, add the allowed_models field under extra for each inference provider, and list the models that you want to expose to users:

   inference:
     providers:
       - type: openai
         id: openai
         api_key_env: OPENAI_API_KEY
         extra:
           allowed_models:
             - gpt-4o-mini

   where:

   allowed_models

   The list of models that appear in the model selection dropdown menu for that provider. Models that you omit from this list are hidden from users.

2. Apply the modified lightspeed-stack.yaml file by using a custom ConfigMap:

   For Operator-based deployments, map the ConfigMap in the extraFiles section of the Backstage custom resource.

   For Helm-based deployments, reference the ConfigMap in the values.yaml file.

3. Apply the updated configuration to your cluster, and restart the deployment if it does not trigger an automatic rollout.

Verification

1. Log in to your RHDH instance.
2. Open the chat dialog and select the model selection dropdown menu.
3. Confirm that the dropdown menu lists only the allowed models.

Procedure

1. Click the Open intelligent assistant floating action button (FAB) at the lower right of the screen to open the chat overlay.

   

2. Optional: Configure the interface display and server settings:

   • Click the Chatbot options icon (⋮) in the header to open the options menu.

     
   • In the Chatbot options menu, toggle Enable pinned chats or Disable pinned chats to show or hide the pinned chats. The system enables this option by default.
   • Available only if Model Context Protocol (MCP) is configured: In the Chatbot options menu, click MCP and Prompt Settings to manage Model Context Protocol connections.

   • In the Chatbot options menu, under Display mode, select any of the following views:

     • Overlay: A floating window is displayed over the current page content.

       

     • Dock to window: A panel attaches to the right side of the screen. Activating this mode automatically closes the Quick start panel if it is already open.

       

     • Fullscreen: A dedicated page opens for intensive chat sessions. This mode displays a revised header containing the Developer Hub Intelligent Assistant icon and a horizontal tab bar, which replaces the previous main menu. Bookmark the URL in your browser to save a direct link to the chat interface.

       

3. Start a chat or load an earlier session:

   • Enter a prompt: Type a query in the Enter a prompt for the intelligent assistant chat field and press Enter.
   • Use a sample: Click a prompt tile.

   • Change the AI model: Select a model from the model selector dropdown menu inside the prompt bar.

     

   • Attach a file: Click the (+) icon on the left of the prompt bar to upload a .yaml, .json, or .txt file. Descriptive text clarifies the function of the icon.

     
   • Use voice: Click the Use microphone icon. The microphone and send buttons are located on the right side of the prompt bar.

   • Control AI generation: Use the control buttons on the right side of the prompt bar. Click the Send (>) button to submit queries, or click the Stop button to halt AI generation.

     
     
   • Resume a chat: Select a title from the Chats list.

4. Organize your chat history:

   • Start a new topic: Click New chat to reset the assistant’s context. When the history panel is collapsed, click the New chat icon to create a new chat.

     
     
   • Search history: Enter a keyword in the Search field.

   • Rename a session: Click Options next to a chat title, select Rename, enter a new name in the Rename chat? dialog, and click Rename.

     
   • Pin a chat: Click Options next to a chat title and select Pin. The chat moves to the Pinned group.

   • Sort chats: Click the Sort control and choose a sorting criterion, such as Date (Newest first).

     

   • Delete a chat: Click Options next to a chat title and select Delete.

     
   • Collapse or expand a category: Click a category header, such as Pinned, Saved prompts, or Recent, to collapse or expand that section of the chat history sidebar.

   • Expand or collapse the panel: Click the Expand/collapse icon to toggle the history panel.

     
     
     Note

     The expanded panel is resizable up to a defined maximum width.

5. Optional: To hide the interface, if you are in the Overlay or Dock to window mode, click the Close intelligent assistant FAB to hide the window. If you are in Fullscreen mode, revert to the other modes and click the Close intelligent assistant FAB. The system preserves your active query and history.

Verification

1. The main window displays the active chat or selected history.
2. The chat history list reflects renamed, pinned, or deleted entries.

Procedure

1. Click the Open intelligent assistant floating action button (FAB) at the lower right of the screen to open the chat overlay.

2. Create a saved prompt:

   1. Click the Chatbot options icon (⋮) in the header and select MCP and Prompt Settings.

      

   2. Click the Saved prompts tab.

      
   3. Click + New prompt.

   4. Enter a Title of 128 characters or fewer and a Prompt of 5,000 characters or fewer.

      

   5. Click Save.

      Note

      By default, you can save up to 100 prompts. When you reach the limit, delete an existing prompt before you create a new one.

3. Reuse a saved prompt from the Saved prompts section of the chat history sidebar or from the Saved prompts tab:

   

   • To insert the prompt into the message field so that you can review or edit it before sending, click the prompt, or select Apply in input box from the prompt’s options menu.

     

   • To insert and submit the prompt immediately, select Send directly from the prompt’s options menu.

     
   Note

   When the sidebar lists more than five saved prompts, click Show all to display the remaining prompts, or click Show less to collapse the list.

4. Optional: To remove a saved prompt, select Delete from the prompt’s options menu, and then confirm the deletion. Deleting a saved prompt is permanent.

   

5. Optional: To open the Saved prompts settings directly, click the settings (gear) icon next to the Saved prompts section in the chat history sidebar.

   
6. Optional: To show or hide the Saved prompts feature, click the Chatbot options icon (⋮) in the header and toggle Enable saved prompts or Disable saved prompts. Saved prompts are enabled by default. When you disable the feature, RHDH hides the Saved prompts section and excludes your saved prompts from the default prompts offered in a new chat.

Verification

1. The Saved prompts tab displays the prompt count and your new prompt.
2. Clicking or sending a saved prompt applies its content in the message field.
3. Deleted prompts are removed from both the sidebar and the Saved prompts tab.

Procedure

1. Log in to your RHDH instance.
2. In the left navigation sidebar, locate the standard or custom items that represent specific global extensions, such as:
3. Tech Radar: Use this to visualize your organization’s approved and deprecated technologies.
4. Cost Insights: Use this to track and analyze cloud infrastructure spending for your projects.
5. Developer Hub Intelligent Assistant: Access this conversational interface for AI-assisted development help and platform queries.
6. Learning Paths: Access training and educational resources to improve your technical skills.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Select a Component or Service card.
4. Review the tabs at the top of the entity page to view configured plugins:
5. CI/CD: Displays build status and history from tools such as Jenkins or GitHub Actions.
6. Kubernetes: Shows deployment status and pod health.
7. Topology: Visualizes the relationships and status of running resources.

Next steps

1. If a build fails in the CI/CD tab, select the build number to view the logs in the source provider.
2. If a pod is failing in the Kubernetes tab, examine the error events to troubleshoot the deployment.

Procedure

1. In the left navigation sidebar, click Extensions.
2. Browse the marketplace to review the following categories:
3. Installed: Review the integrations currently active in your instance, such as Jira, ArgoCD, or GitHub.

4. Available: Examine additional integrations supported by the platform that are not yet enabled for your workspace.

   Note

   End users typically cannot install plugins. If you locate a plugin in the marketplace or the Backstage Plugin Directory that your team requires, contact your administrator to request its installation.

Procedure

1. In the RHDH global header, click your avatar or name to open the user menu.

2. To customize the interface:

   1. Select Settings.

   2. In the Appearance section, configure the following options:

      • Theme: Select Light, Dark, or Auto to synchronize the portal with your operating system preferences.
      • Language: Select your preferred interface language from the list.
      • Pin Sidebar: Use this toggle to keep the left navigation menu expanded. The system enables this feature by default.

3. To check your identity and software ownership:

   1. Open the user menu again and select My Profile.
   2. Review the About card to confirm that your account details, such as email and team tags, are right.
   3. Examine the Ownership card to identify the software components, APIs, and systems linked to your identity.

   4. Use the relations toggle to switch between the following views:

      • Direct Relations: View entities where you are explicitly listed as the owner.
      • Aggregated Relations: View entities inherited through team memberships or group hierarchies.

Procedure

1. In the Red Hat Developer Hub navigation menu, select Catalog.
2. Locate the components you want to add as a favorite.
3. In the Actions column for that component, click the Add to favorites (star) icon.