IBM watsonx

https://www.ibm.com/docs/en/watsonx
Admin
IBM watsonx is an enterprise-ready AI and data platform that brings together new generative AI...
Tokens:7,614,125
Snippets:119,643
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Installation Progress Output

Source: https://www.ibm.com/docs/en/watsonx/waz/3.2.0?topic=s390x-install-watsonx-orchestrate-operator

This output shows an example of the installation progress verification. The `RECONCILE_PROGRESS` column indicates the completion status.

```text
NAME   VERSION   DEPLOYED   VERIFIED   TOTAL   QUIESCE        RECONCILE_PROGRESS   AGE
wo     5.3.0     32         32         32      NOT_QUIESCED   100%                 12d
```

--------------------------------

### Example: Start Hive Metastore Service

Source: https://www.ibm.com/docs/en/watsonxdata/standard/2.0.x?topic=installing-watsonxdata-developer-version

An example demonstrating how to start the 'lh-hive-metastore' service using the `start_service` command.

```bash
$LH_ROOT_DIR/ibm-lh-dev/bin/start_service lh-hive-metastore
```

--------------------------------

### Structured Prompting: Setup Field Examples

Source: https://www.ibm.com/docs/en/watsonxdata/premium/2.2.x?topic=ai-prompt-foundation-model-prompt-lab

Use the 'Setup' field for few-shot examples. Provide input-output pairs to guide the model's response format and content.

```plaintext
Input| Output  
---|---  
When I try to log in, I get an error.| Problem  
Where can I find the plan prices?| Question  
What is the difference between trial and paygo?| Question  
The registration page crashed, and now I can't create a new account.| Problem  
What regions are supported?| Question  
I can't remember my password.| Problem  
```

--------------------------------

### Example Installation Path with Spaces

Source: https://www.ibm.com/docs/en/watsonxdata/standard/1.0.x?topic=watsonxdata-limitations-known-issues

This example illustrates an installation path that contains spaces, which may cause errors when running the setup.sh script for watsonx.data Developer version.

```text
/Users/john/documents/userdata/Hybrid Data Management/Lakehouse/ibm/lh-dev/bin
```

--------------------------------

### Navigate to template directory and set up configuration

Source: https://www.ibm.com/docs/en/watsonx/saas?topic=code-coding-deploying-ai-services-watsonx-ai-cli

After creating a template, navigate to its directory and copy the example configuration and environment files.

```bash
cd <template directory>
cp config.toml.example config.toml
cp template.env .env

```

--------------------------------

### Create Installation Directory

Source: https://www.ibm.com/docs/en/watsonxdata/1.0.x?topic=package-installing-lh-client

Create the directory where the client will be installed and navigate into it.

```bash
mkdir <install_directory>
cd <install_directory>
```

--------------------------------

### Get Parameter Info CLI Example 2

Source: https://www.ibm.com/docs/en/watsonx/wdi/2.3.x?topic=routines-examples

Example command to get parameter information using the DSGetParamInfo script with job name and run name.

```shell
DSGetParamInfo.sh <param_name> --job-name=<jobname> --run-name=<invocation id> or <run name>

```

--------------------------------

### Start and Configure Z Understand Container

Source: https://www.ibm.com/docs/en/watsonx/watsonx-code-assistant-4z/2.x?topic=container-configuring

Start the Z Understand container and apply the configuration specified in the `setup.json` file. This process may take several minutes.

```bash
./start.sh -c setup.json
```

--------------------------------

### Get Parameter Info CLI Example 1

Source: https://www.ibm.com/docs/en/watsonx/wdi/2.3.x?topic=routines-examples

Example command to get parameter information using the DSGetParamInfo script with job ID and run ID.

```shell
DSGetParamInfo.sh <param_name> --job-id=<job id> --run-id=<id of job run>

```

--------------------------------

### Create installation directory

Source: https://www.ibm.com/docs/en/watsonx/waz/3.0.0?topic=z-preparing-your-environment

Create a directory to store installation logs and files, then navigate into it.

```bash
mkdir wxa4z-install <creates a new directory> 
cd wxa4z-install <navigates to the new directory>
```

--------------------------------

### Create and navigate to the installation directory

Source: https://www.ibm.com/docs/en/watsonxdata/standard/2.0.x?topic=package-installing-lh-client

Use these commands to create a new directory for the client installation and change into it.

```bash
mkdir <directory_name>
cd <directory_name>
```

```bash
mkdir clientpackage
cd clientpackage
```

--------------------------------

### Example Promotion Routes Configuration

Source: https://www.ibm.com/docs/en/watsonx/watsonx-code-assistant-4z/1.x?topic=configuration-configuring-zos-connection

This example demonstrates how to configure multiple promotion routes for different development and testing stages.

```text
[DEV1,UNIT,SYS1,SUBSYS1]:[DEV1,INT,SYS1,SUBSYS1]
[DEV1,INT,SYS1,SUBSYS1]:[QA,QA,SYS1,SUBSYS1]
[QA,QA,SYS1,SUBSYS1]:[QA,HOLD,SYS1,SUBSYS1]
[QA,HOLD,SYS1,SUBSYS1]:[PROD,PROD,SYS1,SUBSYS1]
[DEV2,UNIT,SYS1,SUBSYS1]:[DEV2,INT,SYS1,SUBSYS1]
[DEV2,INT,SYS1,SUBSYS1]:[QA,QA,SYS1,SUBSYS1]
[DEV3,UNIT,SYS1,SUBSYS1]:[DEV3,INT,SYS1,SUBSYS1]
[DEV3,INT,SYS1,SUBSYS1]:[QA,QA,SYS1,SUBSYS1]
[QFIX,TSTFIX,SYS1,SUBSYS1]:[QFIX,PREPROD,SYS1,SUBSYS1]
[QFIX,PREPROD,SYS1,SUBSYS1]:[PROD,PROD,SYS1,SUBSYS1]
```

--------------------------------

### Install JupyterLab Extensions

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/1.1.x?topic=image-adding-customizations-images

Add commands to `install-as-user.sh` to install and enable JupyterLab extensions. This example installs `jupyterlab-spreadsheet-editor` and `lckr-jupyterlab-variableinspector`.

```shell
#!/bin/bash
set -e -o pipefail
source /opt/ibm/build/bin/installutils.sh
conda run -n $DSX_SYSTEM_CONDENV pip install \
   lckr-jupyterlab-variableinspector \
   jupyterlab-spreadsheet-editor
fix-condenv-access-system
```

--------------------------------

### Install OS Packages with microdnf

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/1.1.x?topic=image-adding-customizations-images

Add commands to `install-as-root.sh` to install operating system packages. This example installs `poppler-utils` and its dependencies.

```shell
microdnf install -y --nodocs poppler-utils
```

--------------------------------

### Install R Packages

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/1.1.x?topic=image-adding-customizations-images

Add commands to `install-as-user.sh` to install R packages from CRAN or a tar.gz file. This example installs the `foreign` package.

```shell
#!/bin/bash
set -e -o pipefail
source activate $DSX_KERNEL_CONDENV
# subsequent commands affect the conda environment for user code
# ========================================================
# Install R packages from CRAN or tar.gz file or conda repository
# below example installed foreign test package
# users can add any other additional packages similar way
```

--------------------------------

### Copy Sample Configuration File

Source: https://www.ibm.com/docs/en/watsonx/watsonx-code-assistant-4z/2.x?topic=container-configuring

Copy the `setup.sample.json` file to `setup.json` to create a new configuration file for the Z Understand container.

```bash
cp setup.sample.json setup.json
```

--------------------------------

### Install Jupyter Notebook Extensions

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/1.1.x?topic=image-adding-customizations-images

Add commands to `install-as-user.sh` to install and enable Jupyter notebook extensions. This example installs `codefolding` and `freeze`.

```shell
#!/bin/bash
set -e -o pipefail
source /opt/ibm/build/bin/installutils.sh
source activate $DSX_SYSTEM_CONDENV
pip install jupyter_contrib_nbextensions
jupyter contrib nbextension install  --symlink
jupyter nbextension enable codefolding/main --system
jupyter nbextension enable freeze/main --system
```

--------------------------------

### Get Annotations Response Example

Source: https://www.ibm.com/docs/en/watsonx/watsonx-code-assistant-4z/1.x?topic=apis-handling-annotations-by-using-api-urls

This JSON structure represents the response to a get request for annotations.

```json
{
    "annotations_key_1": "annotations_value_1",
    "annotations_key_2": "annotations_value_2",
    "annotations_key_3": "annotations_value_3",
    "annotations_key_4": "annotations_value_4"
}
```

--------------------------------

### Navigate to app directory and set up environment variables

Source: https://www.ibm.com/docs/en/watsonx/saas?topic=code-coding-deploying-ai-services-watsonx-ai-cli

After creating an app, navigate to its directory and copy the example environment file. Update placeholder values in the .env file, including the WATSONX_BASE_DEPLOYMENT_URL.

```bash
cd <created folder with the app>
cp template.env .env

```

--------------------------------

### Execute Setup Phase Action with Static SQL

Source: https://www.ibm.com/docs/en/watsonxdata/premium/2.2.x?topic=notebooks-examples-flight-service-itc-utils-pandas

Uses the `setup_phase` action to run a static SQL statement for preparing partitions or executing SQL. Ensure the `flight_client` is obtained and the `nb_data_request` is correctly formatted.

```python
import itc_utils.flight_service as itcfs
from ibm_watson_studio_lib import access_project_or_space
import pyarrow.flight as flight

flightClient = itcfs.get_flight_client()

nb_data_request = {
    'connection_name': """PostgreSQL""",
    'interaction_properties': {
        'static_statement': 'CREATE TABLE IF NOT EXISTS public.uno2 (id serial, x varchar (32))',
        'write_mode': 'static_statement'
    },
}
flight_request = itcfs.get_data_request(nb_data_request=nb_data_request)
flight_request['context']= 'target'

flight_cmd = itcfs.get_flight_cmd(data_request=flight_request)
print(flight_cmd)

action = flight.Action('setup_phase',flight_cmd.encode('utf-8'))
gen = flightClient.do_action(action)
result = list(gen) # fully consume iterator

```

--------------------------------

### Install OS Packages with microdnf

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/2.0.0?topic=image-adding-customizations-images

Add commands to `install-as-root.sh` to install operating system packages using `microdnf`. This example installs `poppler-utils` and its dependencies.

```bash
microdnf update -y
```

```bash
microdnf install -y --nodocs poppler-utils
```

--------------------------------

### Setup Instance Topology and ConfigMap

Source: https://www.ibm.com/docs/en/watsonxdata/standard/1.1.x?topic=installing-watsonxdata-red-hat-openshift

Install IBM Cloud Pak foundational services and create the required `ConfigMap` for instance topology.

```bash
cpd-cli manage setup-instance-topology \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true \
--block_storage_class=${STG_CLASS_BLOCK}
```

--------------------------------

### Get Installed Component Status

Source: https://www.ibm.com/docs/en/watsonxdata/standard/1.0.x?topic=watsonxdata-uninstalling-components

Run this command to determine which watsonx.data components are currently installed in the project.

```bash
ibm-lakehouse-manage get-cr-status
```

--------------------------------

### Install Python and R Packages

Source: https://www.ibm.com/docs/en/watsonx/w-and-w/1.1.x?topic=image-adding-customizations-images

Add commands to `install-as-user.sh` to install Python or R packages. This example installs `py4j` from Anaconda and `seawater` from PyPI. Install conda packages before pip packages.

```shell
conda install py4j

pip install seawater
```

--------------------------------

### Example Keystore Bind Mount

Source: https://www.ibm.com/docs/en/watsonx/wdi/saas?topic=environments-enabling-https-host-verification

This example demonstrates how to mount a specific keystore file from the user's home directory to the container. The source path is `${HOME}/sdc/my_keystore.p12` and the target is `/etc/sdc/my_keystore.p12`.

```bash
--mount type=bind,source="${HOME}"/sdc/my_keystore.p12,target=/etc/sdc/my_keystore.p12,readonly
```

--------------------------------

### Set up a software instance profile

Source: https://www.ibm.com/docs/en/watsonxdata/standard/2.1.x?topic=cpdctl-config-commands-usage

Use this command to configure an instance profile for a software deployment. It requires a username, password, and the instance URL.

```bash
./cpdctl config profile set onprem --username cpadmin --password xyz --url http://cpd-cpd-instance.apps.docteam-wxd-cluster.cp.fyre.ibm.com/
```
Tokens:
Raw