Add Traceflow User Guide

Add document to guide users how to use Traceflow via Antrea UI. Related: antrea-io#901
mengdie-song · Jul 21, 2020 · 8c0c27d · 8c0c27d
1 parent 4d09ed5
commit 8c0c27d
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 0 deletions.
diff --git a/docs/assets/tf_create.png b/docs/assets/tf_create.png
diff --git a/docs/assets/tf_graph_failure.png b/docs/assets/tf_graph_failure.png
diff --git a/docs/assets/tf_graph_historical.png b/docs/assets/tf_graph_historical.png
diff --git a/docs/assets/tf_graph_success.png b/docs/assets/tf_graph_success.png
diff --git a/docs/assets/tf_overview.png b/docs/assets/tf_overview.png
diff --git a/docs/assets/tf_table.png b/docs/assets/tf_table.png
diff --git a/docs/traceflow-guide.md b/docs/traceflow-guide.md
@@ -0,0 +1,46 @@
+# Traceflow User Guide
+
+## About Traceflow
+Antrea supports using Traceflow for network diagnosis.
+Creating a new Traceflow CRD triggers Traceflow module to inject packet into OVS, provide various observation points
+along the packet's path and populate these observations into status of Traceflow CRD.
+Users can start a new trace simply from Antrea UI/Antrea-Octant-Plugin and view Traceflow result via UI graph.
+We will also provide corresponding Antctl to start a new trace in the near future.
+
+For antrea-octant-plugin installation, please refer to [antrea-octant-installation](/docs/octant-plugin-installation).
+
+## Start a New Trace
+<img src="/docs/assets/tf_create.png" width="600" alt="Start a New Trace">
+
+From Octant Dashboard, you need to click on left navigation bar named "Antrea Information" and then
+choose category named "Traceflow Info" to lead you to the Traceflow UI displayed on the right side.
+
+Now, you can start a new trace by clicking on the button named "Start New Trace" and submit the form with trace details.
+It helps you create a Traceflow CRD and generate a corresponding Traceflow Graph.
+
+## View Traceflow Result
+
+You can always view Traceflow result directly via Traceflow CRD status and see if the packet is successfully delivered
+or somehow dropped by certain component. Antrea also provides a more friendly way by showing the Traceflow result via a
+trace graph on UI.
+
+<img src="/docs/assets/tf_graph_success.png" width="600" alt="Show Successful Trace">
+
+From the graph above, we can see the inter-node traffic between two Pods have been successfully delivered.
+Sometimes the traffic may not be successfully delivered and we can always easily identify where the traffic is dropped
+via a trace graph like below.
+
+<img src="/docs/assets/tf_graph_failure.png" width="600" alt="Show Failing Trace">
+
+You can also generate historical trace graph by providing certain Traceflow CRD name.
+
+<img src="/docs/assets/tf_graph_historical.png" width="600" alt="Generate Historical Trace">
+
+## View Traceflow CRDs
+
+<img src="/docs/assets/tf_overview.png" width="600" alt="Antrea Overview">
+
+You can view the existing Traceflow CRDs from the last table of Antrea Overview on UI.
+Also, you can view all the traceflow CRDs from Tracflow page by clicking the right tab named "Traceflow Info"
+
+<img src="/docs/assets/tf_table.png" width="600" alt="Antrea Overview">