Operate

Red Hat OpenShift Lightspeed 1.0

Using OpenShift Lightspeed

Red Hat OpenShift Documentation Team

Abstract

This documentation provides information about operating OpenShift Lightspeed.

Chapter 1. Operating OpenShift Lightspeed

Submit questions to OpenShift Lightspeed, manage resource attachments, and resolve system alerts to optimize your troubleshooting experience.

1.1. Using the chat window to ask a question

Get immediate product information and support by asking questions through the Red Hat OpenShift Lightspeed icon.

Procedure

  1. Click the Red Hat OpenShift Lightspeed icon in the lower-right corner of the screen.

    This action presents the Red Hat OpenShift Lightspeed user interface.

  2. Enter a question.

  3. Click the Submit button.

    OpenShift Lightspeed returns information based on your question.

1.2. About Lightspeed conversations

Use OpenShift Lightspeed to get help for OpenShift, Kubernetes, and specialized OpenShift components such as OpenShift Virtualization and OpenShift Service Mesh

OpenShift Lightspeed ignores questions unrelated to the target topics. If OpenShift Lightspeed misinterprets your question, try rephrasing the question for better clarity. Conversation history provides context that OpenShift Lightspeed references when generating answers. Using specific language helps increase the success of responses. For example, instead of asking "How do I start a virtual machine?" try asking "How do I start a virtual machine in OpenShift Virtualization?"

Conversation history does not persist if you reload the console page. Reloading the console page performs the same action as clicking the New Chat button. Restarting OpenShift Lightspeed erases conversation history.

1.3. Providing feedback for a conversation

Send feedback to Red Hat on specific OpenShift Lightspeed interactions to improve the quality and accuracy of future responses.

Prerequisites

  • You have installed the OpenShift Lightspeed Operator and deployed the OpenShift Lightspeed service.

Procedure

  1. Click the Red Hat OpenShift Lightspeed icon in the lower-right corner of the screen.
  2. Enter a question into the Send a message field:

  3. Click the Submit button.

    OpenShift Lightspeed returns information.

  4. To send feedback on a particular question and response, click the thumbs up or thumbs down button.

    This action presents the field that you use to enter additional information.

  5. Click the Submit button.

    Your rating, any text you entered, the specific question you asked OpenShift Lightspeed, and the response are all sent to Red Hat for review.

1.4. Sample conversation overview

Use these sample prompts and follow-up strategies to start effective conversations with OpenShift Lightspeed and improve response accuracy.

Some examples show specific workflows to use in the interface. Ask your follow-up questions in the same chat to help create context. Because OpenShift Lightspeed uses the whole chat, follow-up questions help refine the results. You can get better answers by rephrasing your question or asking for more detail.

1.4.1. Asking a general question

Ask general questions about OpenShift Container Platform using OpenShift Lightspeed to quickly find documentation, best practices, and product information.

Procedure

  1. Click the Red Hat OpenShift Lightspeed icon in the lower-right corner of the screen.

  2. Enter the following question into the Send a message field:

    What is an OpenShift image stream used for?

  3. Click the Submit button.

    OpenShift Lightspeed returns information that provides an explanation of an image stream and details about usage.

1.4.3. Attaching a resource object to your question

Attach a cluster resource object to your OpenShift Lightspeed query to give specific context and receive more relevant, data-driven troubleshooting advice.

Procedure

  1. Navigate to a supported resource in the OpenShift Container Platform web console. For example, click Workloads → Pods and then click the name of a pod.
  2. Click the Red Hat OpenShift Lightspeed icon in the lower-right corner of the screen.
  3. Click Add in the Red Hat OpenShift Lightspeed user interface to attach a resource object.
  4. Select the resource object to attach to the question.
  5. Enter a question.

  6. Click the Submit button.

    OpenShift Lightspeed returns information based on your question.

1.4.4. Using OpenShift Lightspeed to troubleshoot alerts

Analyze and resolve cluster alerts by querying OpenShift Lightspeed for root cause explanations, documentation links, and recommended remediation steps.

Procedure

  1. In the OpenShift Container Platform web console, select Observe → Alerting.
  2. Click to expand an alert row.
  3. Click the alert to present it on the screen and view details.
  4. Click the Red Hat OpenShift Lightspeed icon in the lower-right corner of the screen.
  5. Click Attach context and select Alert.

  6. In the Red Hat OpenShift Lightspeed user interface, enter the following text:

    What should I do about this alert?

  7. Click the Submit button.

    The alert provides OpenShift Lightspeed with context when generating a response.

1.5. Starting a new chat conversation

Reset your OpenShift Lightspeed session by clearing the chat history to start a new conversation without influence from the prior context.

When you ask follow-up questions, OpenShift Lightspeed references the conversation history for additional context that influences replies. Whenever you start a new conversation with OpenShift Lightspeed you should clear the chat history.

Procedure

  1. In the Red Hat OpenShift Lightspeed natural language interface, click Clear chat.

    This action clears the history of prior conversations.

  2. Enter a question.

  3. Click the Submit button.

    OpenShift Lightspeed only references the new question when generating a response.

Legal Notice

Copyright © Red Hat.
Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . 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, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.
The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.
All other trademarks are the property of their respective owners.