1. Documentation
×

Operating OpenShift Lightspeed

There are different ways you can access the Red Hat OpenShift Lightspeed user interface.

  • Clicking the Red Hat OpenShift Lightspeed chat window floating icon in the lower-right of the screen

  • Using the Actions dropdown list on specific resources in the OpenShift Container Platform web console

  • Using the Node options icon from a list of resources in the OpenShift Container Platform web console

The following topics provide information about submitting questions to {ols-full}.

Using the chat window to ask a question

This procedure explains how to use the Red Hat OpenShift Lightspeed icon to ask a question using natural language.

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.

    Lightspeed returns information based on your question.

Using the Actions dropdown list to ask a question

This procedure explains how to use the Actions dropdown list to ask OpenShift Lightspeed a question.

Procedure

  1. Navigate to a resource in the OpenShift Container Platform web console. For example, click Workloads → Pods and then click the name of a pod.

  2. Click the Actions dropdown list and select Ask OpenShift Lightspeed.

    This presents the Red Hat OpenShift Lightspeed user interface.

  3. Enter a question.

  4. Click the Submit button.

    Lightspeed returns information based on your question.

Using the Node options icon to ask a question

This procedure explains how to use the Node options to ask OpenShift Lightspeed a question.

Procedure

  1. Navigate to a resource in the OpenShift Container Platform web console. For example, click Workloads → Pods.

  2. Click the Node options icon in the row for a pod and select Ask OpenShift Lightspeed.

    This action presents the Red Hat OpenShift Lightspeed natural language interface.

  3. Enter a question.

  4. Click the Submit button.

    The Lightspeed natural language interface returns information based on your query.

About Lightspeed conversations

OpenShift Lightspeed is designed to answer questions about OpenShift, Kubernetes, and additional OpenShift components, such as OpenShift Virtualization, OpenShift Pipelines, and OpenShift Service Mesh.

OpenShift Lightspeed will not answer questions that are unrelated to the targeted topics. In some cases, you may need to rephrase an ambiguously worded question because OpenShift Lightspeed could not correctly interpret what you asked. Conversation history helps provide 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. Conversation history is also erased if OpenShift Lightspeed is restarted.

Providing feedback for a conversation

OpenShift Lightspeed includes an integrated feedback system. This procedure explains how to provide feedback to Red Hat for a specific OpenShift Lightspeed question and response.

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 message field:

  3. Click the Submit button.

    Lightspeed returns information.

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

    This action presents a field that allows you 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.

Sample conversation overview

The following examples are intended to serve as samples you can use to start a conversation with OpenShift Lightspeed. In some cases, the conversation includes an initial question and then one or more follow-up questions. Rephrasing questions or asking a more precise follow-up question can help increase the success of the reply.

Some of the examples suggest specific workflows to follow in the user interface. Be sure to ask the follow-up questions without starting a new dialog. OpenShift Lightspeed uses the entire conversation as context, so follow-up questions should help refine answers.

Asking a general question

This procedure shows how to ask OpenShift Lightspeed a general question about the OpenShift Container Platform.

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 message field:

    What is an OpenShift imagestream used for?

  3. Click the Submit button.

    Lightspeed returns information that provides an explanation of an imagestream and details about usage.

This procedure shows how to ask OpenShift Lightspeed a series of related questions in order to obtain more highly refined information. Lightspeed uses the conversation history to help create context.

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 message field:

    How are OpenShift security context constraints used?

  3. Click the Submit button.

    Lightspeed returns information.

  4. Enter the following question into the Send message field:

    Can I control who can use a particular SCC?

  5. Click the Submit button.

    Lightspeed returns more highly refined information that contains additional details.

  6. Enter the following question into the Send message field:

    Can you give me an example?

  7. Click the Submit button.

    Lightspeed returns sample code that you can copy and use.

Attaching a resource object to your question

This procedure explains how to attach a resource object to provide additional context for your question.

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 the plus icon in the Red Hat OpenShift Lightspeed user interface to attach a resource object.

  4. Select the resource object to attach to the question.

    You can attach the following resources:

    • CronJob, DaemonSet, Deployment, Job, Pod, ReplicaSet and StatefulSet from Workloads in the OpenShift Container Platform web console.

    • Alert from Observe in the OpenShift Container Platform web console.

    • Services, Routes, Ingresses, and NetworkPolicies from Networking in the OpenShift Container Platform web console.

  5. Enter a question.

  6. Click the Submit button.

    Lightspeed returns information based on your question.

Using Lightspeed to troubleshoot alerts

This procedure shows how to use OpenShift Lightspeed to troubleshoot alerts.

Procedure

  1. In the OpenShift Container Platform web console, select the Administrator perspective.

  2. Click Observe → Alerting.

  3. Click the AlertmanagerReceiversNotConfigured alert.

  4. Copy the title and text of the warning.

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

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

    What should I do about this alert?

  7. Paste the title and text associated with the alert.

  8. Click the Submit button.

    Lightspeed references the alert information to provide context when generating the information it returns.

Starting a new chat conversation

When you ask follow-up questions, OpenShift Lightspeed references the conversation history to provide additional context that influences the replies it generates. Whenever you initiate a new conversation with OpenShift Lightspeed you should clear the chat history.

This procedure explains how to clear the chat history and start a new conversation.

Procedure

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

    This action clears the history of your previous conversation.

  2. Enter a question.

  3. Click the Submit button.

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