ansible · jonquilwilliams · May 6, 2025 · May 5, 2025
diff --git a/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc b/downstream/assemblies/platform/assembly-deploying-chatbot-operator.adoc
@@ -0,0 +1,83 @@
+////
+Retains the context of the parent assembly if this assembly is nested within another assembly.
+For more information about nesting assemblies, see: https://redhat-documentation.github.io/modular-docs/#nesting-assemblies
+See also the complementary step on the last line of this file.
+////
+
+ifdef::context[:parent-context: {context}]
+
+
+[id="deploying-chatbot-operator"]
+= Deploying the {AAPchatbot} on {OCPShort}
+
+:context: deploying-chatbot-operator
+
+[role="_abstract"]
+
+== Overview
+
+The {AAPchatbot} is an intuitive chat interface embedded within the {PlatformNameShort}, utilizing generative artificial intelligence (AI) to answer questions about the {PlatformNameShort}. 
+
+The chat experience in the {AAPchatbot} interacts with users in their natural language prompts in English, and uses Large Language Models (LLMs) to generate quick, accurate, and personalized responses. These responses empower the Ansible users to work more efficiently, thereby improving productivity and the overall quality of their work. 
+
+{AAPchatbot} requires the following configurations:
+
+* Installation of {PlatformNameShort} {PlatformVers} on {OCPShort}
+* Deployment of an LLM served by Red Hat AI platforms, such as Red Hat Enterprise Linux® AI or Red Hat OpenShift AI
+
+[NOTE]
+====
+Red Hat does not collect any telemetry data from your interactions with the {AAPchatbot}. 
+====
+
+== Process for deploying and using the {AAPchatbot}
+
+Perform the following tasks to set up and use the {AAPchatbot} in your {PlatformNameShort} instance on the {OCPShort} environment:
+
+[%header,cols="35%,65%"]
+|====
+| Task 
+| Description
+
+|Deploy the {AAPchatbot} on {OCPShort}
+a|An {PlatformNameShort} administrator who wants to deploy the {AAPchatbot} for all Ansible users in the organization.
+
+Perform the following tasks:
+
+. Install and configure the {PlatformNameShort} operator
+. Create a chatbot configuration secret
+. Update the YAML file of the {PlatformNameShort} to use the chatbot connection secret 
+
+| Access and use the {AAPchatbot}
+| All Ansible users who want to use the intelligent assistant to get answers to their questions about the {PlatformNameShort}.
+|====
+
+== Prerequisites
+
+*For the {PlatformNameShort} {PlatformVers}*: 
+
+* Your system meets the minimum system requirements for installing the {OperatorPlatformNameShort} and the required infrastructure topology. For more information, see link:{URLTopologies}/ocp-topologies[Operator topologies] in _{TitleTopologies}_.
+* You have installed {PlatformNameShort} {PlatformVers} on your {OCPShort} environment. 
+* You have administrator privileges for the {PlatformNameShort}.
+* You have provisioned an OpenShift cluster with Operator Lifecycle Management installed.
+
+*For the Large Language Model (LLM)*:
+
+* You must have configured a Large Language Model (LLM) provider that you will use before deploying the {AAPchatbot}. You can use an LLM served by Red Hat AI platforms, such as Red Hat Enterprise Linux® AI or Red Hat OpenShift AI.
++
+For more information, see the following resources:
+
+** link:https://www.redhat.com/en/products/ai/enterprise-linux-ai[Red Hat Enterprise Linux AI] product page
+** link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_ai/[Red Hat Enterprise Linux AI documentation]
+** link:https://www.redhat.com/en/products/ai/openshift-ai[Red Hat OpenShift AI] product page
+** link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai/[Red Hat OpenShift AI documentation]
+
+== Deploying the {AAPchatbot}
+include::platform/proc-install-aap-operator-chatbot.adoc[leveloffset=+2]
+include::platform/proc-create-chatbot-config-secret.adoc[leveloffset=+2]
+include::platform/proc-update-aap-operator-yaml-chatbot.adoc[leveloffset=+2]
+include::platform/con-using-chatbot.adoc[leveloffset=+1]
+
+
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]
diff --git a/downstream/assemblies/platform/assembly-install-aap-gateway.adoc b/downstream/assemblies/platform/assembly-install-aap-gateway.adoc
@@ -4,7 +4,8 @@ ifdef::context[:parent-context: {context}]
 
 :context: install-aap-gateway
 
-= Installing {PlatformName} gateway on {OCP}
+:chapter: operator-configuration
+= Configuring the {OperatorPlatformName} on {OCP}
 
 As a namespace administrator, you can use {PlatformNameShort} gateway to manage new {PlatformNameShort} components in your OpenShift environment.
 

diff --git a/downstream/assemblies/platform/assembly-install-aap-operator.adoc b/downstream/assemblies/platform/assembly-install-aap-operator.adoc
@@ -3,6 +3,7 @@ ifdef::context[:parent-context: {context}]
 
 [id="install-aap-operator_{context}"]
 
+:chapter: installation
 = Installing the {OperatorPlatformName} on {OCP}
 
 [role="_abstract"]

diff --git a/downstream/attributes/attributes.adoc b/downstream/attributes/attributes.adoc
@@ -181,6 +181,9 @@
 :EnterpriseTopology: enterprise topology
 :EnterpriseTopologyPlural: enterprise topologies
 
+// Chatbot
+:AAPchatbot: Ansible Lightspeed intelligent assistant
+
 // 2.5 Gateway Menu selections
 // These menu selections were based on the UI build environment dated 05/03/24 and should be verified against the final build before GA
 // Top level menu definitions for use only when selections go 3 levels deep.

diff --git a/downstream/images/aap-ansible-lightspeed-intelligent-assistant.png b/downstream/images/aap-ansible-lightspeed-intelligent-assistant.png
diff --git a/downstream/images/chatbot-icon.png b/downstream/images/chatbot-icon.png
diff --git a/downstream/images/sun-icon.png b/downstream/images/sun-icon.png
diff --git a/downstream/modules/platform/con-using-chatbot.adoc b/downstream/modules/platform/con-using-chatbot.adoc
@@ -0,0 +1,30 @@
+[id="con-using-chatbot"]
+
+= Using the {AAPchatbot}
+
+After you deploy the {AAPchatbot}, all Ansible users within the organization can access and use the chat interface to ask questions and receive information about the {PlatformNameShort}.
+
+.Accessing the {AAPchatbot} 
+. Log in to the {PlatformNameShort}. 
+. Click the {AAPchatbot} icon image:chatbot-icon.png[{AAPchatbot} icon] that is displayed at the top right corner of the taskbar.
++
+The {AAPchatbot}  window opens with a welcome message, as shown in the following image:
++
+[.thumb]
+image:aap-ansible-lightspeed-intelligent-assistant.png[{AAPchatbot}]
+
+.Using the {AAPchatbot}
+
+You can perform the following tasks:
+
+* Ask questions in the prompt field and get answers about the {PlatformNameShort} 
+* View the chat history of all conversations in a chat session
+* Search the chat history using a user prompt or answer 
++
+The chat history is deleted when you close an existing chat session or log out from the {PlatformNameShort}.
+* Restore a previous chat by clicking the relevant entry from the chat history
+* Provide feedback on the quality of the chat answers, by clicking the *Thumbs up* or *Thumbs down* icon 
+* Copy and record the answers by clicking the *Copy* icon 
+* Change the mode of the virtual assistant to dark or light mode, by clicking the *Sun* icon image:sun-icon.png[Sun icon] from the top right corner of the toolbar
+* Clear the context of an existing chat by using the *New chat* button in the chat history
+* Close the chat interface while working on the {PlatformNameShort}
diff --git a/downstream/modules/platform/proc-create-chatbot-config-secret.adoc b/downstream/modules/platform/proc-create-chatbot-config-secret.adoc
@@ -0,0 +1,30 @@
+[id="proc-create-chatbot-config-secret"]
+
+= Creating a chatbot configuration secret 
+
+Create a configuration secret for the {AAPchatbot}, so that you can connect the intelligent assistant to the {PlatformNameShort} operator.
+
+.Procedure
+. Log in to {OCP} as an administrator.
+. Navigate to menu:Workloads[Secrets].
+. From the *Projects* list, select the namespace that you created when you installed the {PlatformNameShort} operator.
+. Click menu:Create[Key/value secret].
+. In the *Secret name* field, enter a unique name for the secret. For example, `chatbot-configuration-secret`. 
+. Add the following keys and their associated values individually:
++
+[%header,cols="25%,75%"]
+|====
+| Key 
+| Value
+
+h|`chatbot_model`
+|Enter the LLM model name that is configured on your Red Hat OpenShift AI or Red Hat Enterprise Linux AI setup. 
+
+|`chatbot_url`
+|Enter the inference API base URL on your Red Hat OpenShift AI or Red Hat Enterprise Linux AI setup. For example, `\https://your_inference_api/v1`.  
+
+|`chatbot_token`
+|Enter the API token or the API key. This token is sent along with the authorization header when an inference API is called.  
+|====
+
+. Click *Create*. The chatbot authorization secret is successfully created.
diff --git a/downstream/modules/platform/proc-install-aap-operator-chatbot.adoc b/downstream/modules/platform/proc-install-aap-operator-chatbot.adoc
@@ -0,0 +1,26 @@
+
+[id="proc-install-operator-chatbot"]
+
+= Installing and configuring the {PlatformNameShort} operator
+
+Install and configure the {PlatformNameShort} operator on the {OCPShort}, so that you can deploy and use the {AAPchatbot}.
+
+:chapter: chatbot
+== Installing the {PlatformNameShort} operator
+Install the {PlatformNameShort} operator on {OCPShort}.
+
+include::proc-install-aap-operator.adoc[leveloffset=+1]
+
+* Verify that the {PlatformNameShort} operator displays a *Succeeded* status. 
+
+:chapter: chatbot-configuration
+== Configuring the {PlatformNameShort} operator
+After installing the {OperatorPlatformNameShort} in your namespace, configure the {PlatformNameShort} operator to link your components to the {Gateway}.
+
+include::proc-operator-link-components.adoc[leveloffset=+2]
+
+You must also verify that all the pods are running successfully. Perform the following steps:
+
+. Navigate to menu:Workloads[Pods].
+. Switch to the project named as described in the namespace metadata in the *YAML* configuration view.
+. Verify that all pods display either a *Running* or *Completed* status, with no pods displaying an error status.
diff --git a/downstream/modules/platform/proc-install-aap-operator.adoc b/downstream/modules/platform/proc-install-aap-operator.adoc
@@ -1,4 +1,4 @@
-[id="proc-install-aap-operator"]
+[id="proc-install-aap-operator-{chapter}"]
 
 .Procedure
 . Log in to {OCP}.

diff --git a/downstream/modules/platform/proc-operator-link-components.adoc b/downstream/modules/platform/proc-operator-link-components.adoc
@@ -1,4 +1,4 @@
-[id="operator-link-components_{context}"]
+[id="operator-link-components_{context}_{chapter}"]
 
 = Linking your components to the {Gateway}  
 

diff --git a/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc b/downstream/modules/platform/proc-update-aap-operator-yaml-chatbot.adoc
@@ -0,0 +1,46 @@
+[id="proc-update-aap-operator-chatbot"]
+
+= Updating the YAML file of the {PlatformNameShort} operator 
+
+After you create the chatbot authorization secret, you must update the YAML file of the {PlatformNameShort} operator to use the secret.
+
+.Procedure
+. Log in to {OCP} as an administrator.
+. Navigate to menu:Operators[Installed Operators].
+. From the list of installed operators, select the *{PlatformNameShort}* operator.
+. Locate and select the *{PlatformNameShort}* custom resource, and then click the required app.
+. Sel
FAD9
ect the *YAML* tab.
+. Scroll the text to find the `spec:` section, and add the following details under the `spec:` section:
++
+----
+spec:
+  lightspeed:
+    disabled: false
+    chatbot_config_secret_name: <name of your chatbot configuration secret>
+----
+. Click *Save*. The {AAPchatbot} service takes a few minutes to set up. 
+
+.Verification
+. Verify that the chat interface service is running successfully:
+.. Navigate to menu:Workloads[Pods].
+.. Filter with the term *api* and ensure that the following APIs are displayed in *Running* status:
++
+* `myaap-lightspeed-api-<version number>`
+* `myaap-lightspeed-chatbot-api-<version number>`
+
+. Verify that the chat interface is displayed on the {PlatformNameShort}:
+.. Access the {PlatformNameShort}:
+... Navigate to menu:Operators[Installed Operators].
+... From the list of installed operators, click *Ansible Automation Platform*. 
+... Locate and select the *Ansible Automation Platform* custom resource, and then click the app that you created.
+... From the *Details* tab, record the information available in the following fields:
+* *URL*: This is the URL of your {PlatformNameShort} instance. 
+* *Gateway Admin User*: This is the username to log into your {PlatformNameShort} instance.
+* *Gateway Admin password*: This is the password to log into your {PlatformNameShort} instance. 
+... Log in to the {PlatformNameShort} using the URL, username, and password that you recorded earlier. 
+.. Access the {AAPchatbot}:
+... Click the {AAPchatbot} icon image:chatbot-icon.png[{AAPchatbot} icon] that is displayed  at the top right corner of the taskbar. 
+... Verify that the chat interface is displayed, as shown in the following image:
++
+[.thumb]
+image:aap-ansible-lightspeed-intelligent-assistant.png[{AAPchatbot}].
diff --git a/downstream/titles/aap-operator-installation/master.adoc b/downstream/titles/aap-operator-installation/master.adoc
@@ -33,7 +33,14 @@ include::platform/assembly-operator-configure-gateway.adoc[leveloffset=+2]
 
 include::platform/assembly-installing-controller-operator.adoc[leveloffset=+2]
 
-include::platform/platform/proc-operator-deploy-redis.adoc[leveloffset=+2]
+// include::platform/assembly-installing-controller-operator-local-db.adoc[leveloffset=+1]
+
+// [sayjadha]Added the chatbot deployment info. in OCP install guide.
+include::platform/assembly-deploying-chatbot-operator.adoc[leveloffset=+1]
+
+// [gmurray] Commenting out this module as covered in assembly-configure-aap-operator.adoc
+// include::platform/assembly-deploy-eda-controller-on-aap-operator.adoc[leveloffset=+1]
+include::platform/platform/proc-operator-deploy-redis.adoc[leveloffset=+1]
 
 
 include::platform/assembly-aap-migration.adoc[leveloffset=+1]