| Daniele Moro | 5212da6 | 2021-10-11 16:20:26 +0200 | [diff] [blame] | 1 | .. _troubleshooting_guide: |
| 2 | |
| Charles Chan | caebcf3 | 2021-09-20 22:17:52 -0700 | [diff] [blame] | 3 | Troubleshooting Guide |
| 4 | ===================== |
| Charles Chan | bf55e74 | 2021-10-04 17:46:46 -0700 | [diff] [blame] | 5 | |
| 6 | Frequently Used Commands |
| 7 | ------------------------ |
| 8 | In this section, we are going to introduce a few commands we frequently used when troubleshooting SD-Fabric. |
| 9 | |
| 10 | ONOS |
| 11 | ^^^^ |
| 12 | To execute following ONOS CLI commands, |
| 13 | |
| 14 | - Create K8s port forwarding by `kubectl -n tost port-forward onos-tost-onos-classic-0 8101` |
| 15 | - Login to ONOS CLI by `ssh -p 8101 karaf@localhost`. Default password is `karaf` |
| 16 | |
| 17 | ONOS basics |
| 18 | """"""""""" |
| 19 | - `flows`: List flow tables. `-s` for simplified output. |
| 20 | - `groups`: List group tables. `-s` for simplified output. |
| 21 | - `devices`: List device information. `-s` for simplified output. |
| 22 | - `ports`: List port information. `-e` to list enabled ports only. |
| 23 | - `links`: List discovered links |
| 24 | - `hosts`: List discovered hosts. `-s` for simplified output. |
| 25 | - `netcfg`: List network configuration |
| 26 | - `interfaces`: List interface configuration |
| 27 | |
| 28 | trellis-control |
| 29 | """"""""""""""" |
| 30 | - `sr-pr-list`: List current recovery phase of each device |
| 31 | - `sr-device-subnets`: List device-subnet mapping |
| 32 | |
| 33 | fabric-tna |
| 34 | """""""""" |
| 35 | - `slices`: List network slices |
| 36 | - `tcs`: List traffic classes of given slice |
| 37 | |
| 38 | up4 |
| 39 | """ |
| 40 | - `read-interfaces`: List all interfaces installed in the data plane |
| 41 | - `read-pdrs`: List all PDRs installed in the data plane |
| 42 | - `read-fars`: List all FARS installed in the data plane |
| 43 | - `read-flows`: List all UE data flows installed in the data plane) |
| 44 | |
| 45 | Stratum |
| 46 | ^^^^^^^ |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame^] | 47 | To execute following BF Shell commands, |
| Charles Chan | bf55e74 | 2021-10-04 17:46:46 -0700 | [diff] [blame] | 48 | |
| 49 | - Login to Stratum switch by `ssh root@<switch_ip>`. Default password is `onl` |
| 50 | - Attach to Stratum docker container by `docker attach \`docker ps | grep stratum-bfrt | awk \'{print $1}\'\`` |
| 51 | |
| 52 | - Hit `enter` for the prompt |
| 53 | - Use `<Ctrl-P><Ctrl-Q>` to exit the container. Do not use `<Ctrl-C>` since it will terminate the process. |
| 54 | |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame^] | 55 | BF Shell |
| 56 | """""""" |
| Charles Chan | bf55e74 | 2021-10-04 17:46:46 -0700 | [diff] [blame] | 57 | - `pm.show`: List port configurations. `-a` to list all ports. |
| 58 | |
| 59 | K8s troubleshooting |
| 60 | ------------------- |
| 61 | .. |
| 62 | TODO Hung-Wei |
| 63 | |
| pudelkoM | 964f63e | 2021-10-08 11:10:28 -0700 | [diff] [blame] | 64 | ONOS diagnostics |
| Charles Chan | bf55e74 | 2021-10-04 17:46:46 -0700 | [diff] [blame] | 65 | ---------------- |
| 66 | .. |
| 67 | TODO Hung-Wei |
| 68 | |
| 69 | FAQ |
| 70 | --- |
| 71 | .. |
| 72 | TODO Hung-Wei |