Post-installation setup for watsonx Code Assistant for Z Understand

After you install watsonx Code Assistant™ for Z Understand, you must set up the service before you can use watsonx Code Assistant for Z Understand to analyze your data.

Complete the following steps to set up the watsonx Code Assistant for Z Understand service:

Creating a deployment space

watsonx Code Assistant for Z Understand requires at least one deployment space. You can configure additional deployment spaces if you want to assign different groups of users to different deployment spaces.

  1. Log in to IBM® Software Hub.
  2. Switch to the Code Assistant™ experience, if needed.
    Tip: To switch between experiences, click the Switch locations icon in the toolbar.
  3. Create a deployment.
    1. From the navigation menu, click Deployments.
    2. Click New deployment space.
    3. Enter a name for your new deployment space, then click Create.
  4. If the Mistral model is deployed within the same IBM Software Hub instance, copy the space GUID from the deployment space to the field in the watsonx Code Assistant for Z Understand custom resource.
    oc patch UnderstandAgentOrchestrator understandagentorchestrator-cr \
    --namespace ${PROJECT_CPD_INST_OPERANDS} \
    --type=json \
    --patch='[{"op": "add", "path": "/spec/spaceID", "value": "<SPACE_GUID>"}]'
    Note:

    You can forward model requests from IBM® watsonx Code Assistant™ for Z Understand (wca4zunderstand) service installed on the IBM Software Hub to a model that is not deployed on IBM Software Hub using the Model Gateway. For more information on configuring the Model Gateway in the Red Hat® OpenShift® Container platform cluster, see Configuring Model Gateway.

Adding asset connections

  1. Gather the required certificates and host names.
    • Understand route hostname
    • Refactor route hostname
    • Understand ca root certificate and save as understand-root-ca.crt
      If you are using default self-signed certificates, then run the following OpenSSL command to save the Understand Root CA certificate as understand-root-ca.crt.
      openssl s_client -showcerts \
      -connect $UNDERSTAND_FQDN:$UNDERSTAND_PORT \
      </dev/null 2>/dev/null | \
      awk '/BEGIN CERTIFICATE/,/END CERTIFICATE/ {print}' | \
      awk 'BEGIN {cert=0} /BEGIN CERTIFICATE/ {cert++; buffer=""} {buffer=buffer $0 "\n"} /END CERTIFICATE/ { if(cert==2) { printf "%s", buffer exit } }' > understand-root-ca.crt
    • Refactor certificate and save as refactor.crt. The cert file is also available at $CERTS_LOCATION/refactoring-assistant-ui.crt.
  2. Create a deployment space in CPD instance using the CPD web UI with the following asset connections:
    Name Description Connection Details
    FILE ENDPOINT_TYPE=FILESYSTEM
    • SSL cert - understand-root-ca.crt
    • Url - https://${UNDERSTAND_ROUTE_HOSTNAME}:443
    GRAPHQL ENDPOINT_TYPE=GRAPHQL
    • SSL Cert - understand-root-ca.crt
    • Url - https://${UNDERSTAND_ROUTE_HOSTNAME}:443
    DEX ENDPOINT_TYPE=DEX
    • SSL Cert - understand-root-ca.crt
    • Url - https://${UNDERSTAND_ROUTE_HOSTNAME}:443
    REFACTOR ENDPOINT_TYPE=REFACTOR
    • SSL Cert - refactor.crt
    • Url - https://${REFACTOR_ROUTE_HOSTNAME}:443
    VECTORDB ENDPOINT_TYPE=VECTORDB
    • SSL Cert - your vectordb cert if https enabled
    • Url - your vector db hostname