Enabling the IBM Software Hub AI assistant feature

Premium This feature is available only in IBM Software Hub Premium Cartridge.

To use the IBM Software Hub AI assistant service, you must enable the AI assistant feature in IBM Software Hub.

Who needs to complete this task?
Instance administrator To enable the IBM Software Hub AI assistant feature, you must be an instance administrator.
When do you need to complete this task?
Complete this task if you want to set up the IBM Software Hub AI assistant.

Repeat as needed If you have multiple instances of IBM Software Hub, complete this task for each instance where you want to enable the AI assistant feature.

Before you begin

You must complete the following tasks before you enable the IBM Software Hub AI assistant feature:

  1. Set up a client workstation.
  2. Check which image the cpd-cli is using, run the appropriate command based on the container runtime on the client workstation:
    Docker 
    docker ps
    Podman 
    podman ps
  3. Take the appropriate action based on the image that the cpd-cli is using:
    olm-utils-premium-v4
    If the cpd-cli is using the olm-utils-premium-v4 image, you're ready to enable the AI assistant feature.
    olm-utils-v4
    If the cpd-cli is using the olm-utils-v4 image, set the OLM_UTILS_IMAGE environment variable. based on the location that you pull images from:
    IBM Entitled Registry
    x86-64 clusters
    export OLM_UTILS_IMAGE=cp.icr.io/cp/cpd/olm-utils-premium-v4:${VERSION}.amd64
    ppc64le clusters
    export OLM_UTILS_IMAGE=cp.icr.io/cp/cpd/olm-utils-premium-v4:${VERSION}.ppc64le
    s390x clusters
    export OLM_UTILS_IMAGE=cp.icr.io/cp/cpd/olm-utils-premium-v4:${VERSION}.s390x
    Private container registry
    x86-64 clusters
    export OLM_UTILS_IMAGE=${PRIVATE_REGISTRY_LOCATION}/cp/cpd/olm-utils-premium-v4:${VERSION}.amd64
    ppc64le clusters
    export OLM_UTILS_IMAGE=${PRIVATE_REGISTRY_LOCATION}/cp/cpd/olm-utils-premium-v4:${VERSION}.ppc64le
    s390x clusters
    export OLM_UTILS_IMAGE=${PRIVATE_REGISTRY_LOCATION}/cp/cpd/olm-utils-premium-v4:${VERSION}.s390x

About this task

The IBM Software Hub AI assistant is not enabled by default. When you enable the AI assistant feature, IBM Software Hub starts the following services:
The broker service (platform-ai-assistant-broker-svc)
IBM Software Hub uses the AI assistant broker service to:
  • Send questions to the gen AI agent
  • Submit API calls to retrieve metrics about your environment
The AI agent service (platform-ai-agent-svc)
IBM Software Hub uses the AI agent service for:
  • Document search and RAG
  • Responding to user questions about user management, monitoring, and services
  • Performing troubleshooting analysis

Procedure

To enable the AI assistant feature:

  1. Log the cpd-cli in to the Red Hat® OpenShift® Container Platform cluster: 
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Run the enable-premium-features command: 
    cpd-cli manage enable-premium-features \
--license_acceptance=true \
--features=ai-assistant \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS}