Birdwatcher debugging tool

Birdwatcher is a command-line debugging tool for Milvus. Using Birdwatcher, you can connect to etcd and check the state of the Milvus system.

watsonx.data on Red Hat® OpenShift®

watsonx.data Developer edition

etcd is a metadata engine that manages the storage and access of metadata. This topic explains how to connect and execute Birdwatcher with etcd.

Download and set up Birdwatcher

To download and set up Birdwatcher, complete the following steps:

Download the latest Birdwatcher binary file from the Assets section here or by running the following command.

curl –Lo birdwatcher.tar.gz <latest-birdwatcher-binary-link>

For example:

curl –Lo birdwatcher.tar.gz https://github.com/milvus-io/birdwatcher/releases/download/v1.0.5/birdwatcher_Linux_x86_64.tar.gz

Run the following command to extract the Birdwatcher binary file.
```
$ tar -xvzf birdwatcher.tar.gz
```
Run the following command to make the extracted file executable.
```
$ chmod +x birdwatcher.tar.gz
```
Run the following command to port forward the etcd port in CPD.
```
$kubectl port-forward <etcd-pod-name> <LOCAL_PORT>:<POD_PORT>
```
For example:
```
$kubectl port-forward ibm-lh-lakehouse-milvus922-etcd-0 2379:2379
```
Port forwarding is used to allow clients to communicate with the etcd cluster through a single endpoint.
Run the following command to connect to your etcd pod.
```
$ oc exec-it <etcd-pod-name> bash
```
Run the following command to change to the /mnt/infra/tls/ directory inside the etcd pod.
```
$ cd /mnt/infra/tls/
```
Copy the TLS certificate (tls.crt), TLS key (tls.key), and CA certificate (ca.crt) to your directory.

Run the following commands:

Connect Birdwatcher to etcd.

connect --etcd localhost:<LOCAL_PORT> --enableTLS true --etcdCert <tls.crt path> --etcdKey <tls.key path> --rootCAPem <ca.crt path>

For example:

connect --etcd localhost:2379 --enableTLS true --etcdCert /root/cert/tls.crt --etcdKey
/root/cert/tls.key --rootCAPem /root/cert/ca.crt

For information about using Birdwatcher, see Use Birdwatcher.