Debug tools

3 Debug tools

Overview

The Debug Tools provides third-party troubleshooting tools for debugging the runtime issues for the lab and production environment. Following are the available tools:

tcpdump
ip
netstat
curl
ping
dig

Debug Tool Usage

Following is the procedure to run Debug Tool:

Run the following command to retrieve the POD details:

$ kubectl get pods -n <k8s namespace>

After installation the debug-tool container will get injected into the pods, sample get pod output is here :

 [root@master ~]# kubectl get po -n cncc
NAME                                         READY   STATUS   RESTARTS   AGE
cncc-acore-cmservice-947cf4c89-76vq6          2/2     Running   0         19m
cncc-acore-ingress-gateway-764f7f5f77-qnr5p   2/2     Running   0         19m
cncc-iam-ingress-gateway-55987f7dc9-x5nt2     2/2     Running   0         147m
cncc-iam-kc-0                                 2/2     Running   0         147m
cncc-mcore-cmservice-947cf4c89-76vq6          2/2     Running   0         19m
cncc-mcore-ingress-gateway-764f7f5f77-qnr5p   2/2     Running   0         19m

Run the following command to enter Debug Tools Container:

kubectl exec -it <pod name> -c <debug_container name> -n <namespace> bash

Example:

kubectl exec -it cncc-mcore-ingress-gateway-599d858867-x9pvz -c tools -n cncc bash

Run the debug tools:
```
bash -4.2$ <debug_tools>
```
Example:
```
bash -4.2$ tcpdump
```

Run the following command to copy output files from container to host:

$ kubectl cp -c <debug_container name>  <pod name>:<file location in container> -n <namespace>  <destination location>

Example:

$ kubectl cp -c tools -n cncc cncc-mcore-ingress-gateway-764f7f5f77-qnr5p:/tmp/capture.pcap /tmp/

Steps to Enable Debug Tools Container

Debug tools container can be enabled or disabled for CNCC components by using helm install or helm upgrade command.

Run the following command to enable or disable debug tool on a installed setup after updating the occncc_custom_values_<version>.yaml file:

$ helm upgrade <release_name> -f occncc_custom_values_<version>.yaml <helm-repo> --version <helm_version>

Example:

$ helm upgrade cncc -f occncc_custom_values_22.4.1.yaml ocspf_helm-repo/cncc --version 22.4.1

Important:

For more information, see "Debug tools" in Oracle Communications Cloud Native Core Console Installation and Upgrade Guide.