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. Add the following YAML file as a config map to your namespace:

   version: 2
   image_name: redhat-ai-dev-llama-stack-no-guard
   apis:
     - agents
     - inference
     - safety
     - tool_runtime
     - vector_io
     - files
   container_image:
   external_providers_dir:
   providers:
     agents:
       - config:
           persistence:
             agent_state:
               namespace: agents
               backend: kv_default
             responses:
               table_name: responses
               backend: sql_default
         provider_id: meta-reference
         provider_type: inline::meta-reference
     inference:
       - provider_id: ${env.ENABLE_VLLM:+vllm}
         provider_type: remote::vllm
         config:
           url: ${env.VLLM_URL:=}
           api_token: ${env.VLLM_API_KEY:=}
           max_tokens: ${env.VLLM_MAX_TOKENS:=4096}
           tls_verify: ${env.VLLM_TLS_VERIFY:=true}
       - provider_id: ${env.ENABLE_OLLAMA:+ollama}
         provider_type: remote::ollama
         config:
           url: ${env.OLLAMA_URL:=http://localhost:11434}
       - provider_id: ${env.ENABLE_OPENAI:+openai}
         provider_type: remote::openai
         config:
           api_key: ${env.OPENAI_API_KEY:=}
       - provider_id: ${env.ENABLE_VERTEX_AI:+vertexai}
         provider_type: remote::vertexai
         config:
           project: ${env.VERTEX_AI_PROJECT:=}
           location: ${env.VERTEX_AI_LOCATION:=us-central1}
       - provider_id: sentence-transformers
         provider_type: inline::sentence-transformers
         config: {}
     tool_runtime:
       - provider_id: model-context-protocol
         provider_type: remote::model-context-protocol
         config: {}
       - provider_id: rag-runtime
         provider_type: inline::rag-runtime
         config: {}
     vector_io:
       - provider_id: faiss
         provider_type: inline::faiss
         config:
           persistence:
             namespace: vector_io::faiss
             backend: faiss_kv
     files:
       - provider_id: localfs
         provider_type: inline::localfs
         config:
           storage_dir: /tmp/llama-stack-files
           metadata_store:
             table_name: files_metadata
             backend: sql_files
   storage:
     backends:
       kv_default:
         type: kv_sqlite
         db_path: /tmp/kvstore.db
       sql_default:
         type: sql_sqlite
         db_path: /tmp/sql_store.db
       sql_files:
         type: sql_sqlite
         db_path: /rag-content/vector_db/rhdh_product_docs/1.9/files_metadata.db
       faiss_kv:
         type: kv_sqlite
         db_path: /rag-content/vector_db/rhdh_product_docs/1.9/faiss_store.db
     stores:
       metadata:
         namespace: registry
         backend: faiss_kv
       inference:
         table_name: inference_store
         backend: sql_default
         max_write_queue_size: 10000
         num_writers: 4
       conversations:
         table_name: openai_conversations
         backend: sql_default
   registered_resources:
     models:
       - model_id: sentence-transformers/all-mpnet-base-v2
         metadata:
           embedding_dimension: 768
         model_type: embedding
         provider_id: sentence-transformers
         provider_model_id: /rag-content/embeddings_model
     tool_groups:
       - provider_id: rag-runtime
         toolgroup_id: builtin::rag
     vector_dbs:
       - vector_db_id: rhdh-product-docs-1_8
         embedding_model: sentence-transformers/all-mpnet-base-v2
         embedding_dimension: 768
         provider_id: faiss
   server:
     auth:
     host:
     port: 8321
     quota:
     tls_cafile:
     tls_certfile:
     tls_keyfile:

2. Mount the config map to your Llama Stack container at /app-root/run.yaml to make sure it overrides the default image file:

   name: llama-stack
   volumeMounts:
   - mountPath: /app-root/run.yaml
     subPath: run.yaml
     name: llama-stack-config

3. Configure the required volume:

   volumes:
   - name: llama-stack-config
     configMap:
       name: llama-stack-config

   where:

   llama-stack-config

   The config map where you added the new no-guard configuration file.

4. Restart the deployment if it does not trigger an automatic rollout.

Procedure

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

2. Optional: Configure the interface display:

   • Click the Chatbot options icon (⋮) to view chat history or start a new chat.

   • Click the Display menu icon and 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. You can bookmark this URL for direct access.

       
     • Optional: Toggle Enable pinned chats/Disable pinned chats to enable or hide the pinned chats. The system enables this option by default.

3. Start a chat or load an earlier session:

   • Enter a prompt: Type a query in the Enter a prompt for Lightspeed chat field and press Enter.
   • Use a sample: Click a prompt tile, such as Deploy with Tekton.

   • Attach a file: Click Attach to upload a .yaml, .json, or .txt file.

     1. Click the file name to open the preview model.

     2. View or edit the content of the file:

        
   • Use voice: Click the Use microphone icon.
   • Resume a chat: Select a title from the Recent list.

4. Organize your chat history:

   • Start a new topic: Click New chat to reset the assistant’s context.
   • Search history: Enter a keyword in the Search field.

   • Rename a session: Click Options next to a chat title, select Rename, and enter a new name.

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

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

     

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

     
   • Hide the chat history section and reduce visual noise: Select the Close icon (x) next to New chat.
   • Restore access to your pinned chat: Select the Chat history menu icon.
5. Optional: To hide the interface, if you are in the Overlay or Dock to window mode, click the Close Lightspeed icon (X) to hide the window. If you are in Fullscreen mode, revert to the other modes and click the Close Lightspeed icon (X). The system preserves your active query and history.
6. Optional: In Fullscreen mode, bookmark the URL in your browser to save a direct link to the chat interface.

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. 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 Lightspeed for RHDH: 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.