doc reviewed

Author: Harsh Arora

deploy/troubleshoot.md

@@ -1,83 +1,73 @@
-# Troubleshoot guide
+# CNC troubleshooting
 
-Quick help Guide for some of the common issues that may arise.
+This document explains how to troubleshoot issues that you may encounter while using the Citrix Kubernetes node controller (CNC). Using this document, you can collect logs to determine the causes and apply workarounds for some of the common issues related to the configuration of the CNC
 
-To validate Citrix ADC and basic node configurations, Refer screenshots on [deployment](README.md) page.
+To validate Citrix ADC and the basic node configurations, refer to the image on the [deployment](README.md) page.
 
 ### Service status DOWN
 
-We can verify few things to debug the issue of services being in DOWN state.
+To debug the issues when the service is in down state,
 
-1. Verify logs of CNC pod using:
+1. Verify the logs of the CNC pod using the following command::
 
    ```
    kubectl logs <cnc-pod> -n <namespace>
    ```
 
-   Look for any "permission" ERRORs in logs. As stated in deployment page, CNC creates "kube-cnc-router" pods    which need NET_ADMIN privilege to do the configurations on nodes. So, CNC serviceaccount must have 
-   NET_ADMIN privilege and the ability to create HOST mode "kube-cnc-router" pods.
+   Check for any 'permission' errors in the logs. CNC creates kube-cnc-router pods which require                 NET_ADMIN privilege to perform the configurations on nodes. So, the CNC service account must have the         NET_ADMIN privilege and the ability to create host mode kube-cnc-routerpods.
 
-2. Verify logs of kube-cnc-router pod using:
+2. Verify the logs of the kube-cnc-router pod using the following command:
 
    ```
    kubectl logs <kube-cnc-pod> -n <namespace>
    ```
 
-   Look for any ERROR in node configuration. A typical router pod log would look like:
+   Check for any error in the node configuration. The following is a sample typical router pod log:
 
    <img src="../images/router-pod-log.png" width="600" height="300">
 
-3. Verify kube-cnc-router configmap output using:
+3. Verify the kube-cnc-router configmap output using the following command:
 
    ```
    kubectl get configmaps -n <namespace> kube-cnc-router -o yaml
    ```
-   Look for Empty field in the data section of configmap. A typical 2 node data section would look like:
+   Check for empty field in the data section of the configmap. The following is a sample typical two node        data section:
 
    <img src="../images/router-cmap-data.png" width="600" height="300">
 
-4. Verify Node config:
-   - CNC interface "cncvxlan<md5_of_namespace>" should getcreated
-       - assigned VTEP IP shoud be same as the corresponding router gateway entry in ADC
-       - status of interface should be UP and RUNNING
-   - iptable rule port should created.
-       - port should be same as that of vxlan created on ADC
+4. Verify the node configuration and make sure the following:
+   - CNC interface cncvxlan<md5_of_namespace> should be created.
+       - Assigned VTEP IP address should be the same as the corresponding router gateway entry in Citrix ADC.
+       - Status of interface should be functioning.
+   - iptable rule port should be created.
+       - Port should be the same that of VXLAN created on Citrix ADC.
 
-
    <img src="../images/worker-1.png" width="600" height="300">
 
 
-### Service status UP but ping from ADC not working
+### If the service status is up and operational, but the ping from Citrix ADC is not working
+
+If you are not able to ping the service IP address from Citrix ADC even though the services are in operational state. One reason may be the presence of a PBR entry which directs the packets from Citrix ADC with SRCIP as NSIP to the default gateway.
 
-It is possible that user is unable to ping service IP from Citrix ADC even though services are in UP state.
-One probable reason for this could be the presence of a PBR entry which directs the packets from ADC with SRCIP as NSIP to a default gateway.
-It doesn't impact any functionality. User can ping with Citrix ADC's VTEP as source IP using -S option of ping command from Citrix ADC CLI prompt as seen below.
+It does not impact any functionality. You can use the VTEP of Citrix ADC as source IP address using the -S option of ping command in the Citrix ADC command line interface. For example:
 
    ```
    ping <serviceIP> -S <vtepIP>
    ```
+Note: If it is necessary to ping with NSIP itself, then, you must remove the PBR entry or add a new PBR entry for the endpoint with high priority.
 
-Note: If it is absolutely required to ping with NSIP itself, then as of now, user need to remove the PBR entry or add new PBR entry for endpoint with higher priority
-
-### Curl to the pod endpoint/VIP not working
-
-This is the case wherein though services are UP, still user can't curl to the pod endpoint,that means, stateful TCP session to endpoint fails. 
-One Probable reason for this could be the ns mode "MBF" set to Enable. This issue depends upon deployments and might occur only on certain versions of ADC.
-
-To resolve this, Either:
-- Disable MBF ns mode
-or
-- Bind a netprofile with netprofile Disabled to the servicegroup
-
-Note: As of now, if disabling MBF resolves the issue, then it need to be kept disabled.
+### cURL to the pod endpoint or VIP is not working
 
-## Customer Support
+Though, services are in up state, still you cannot cURL to the pod endpoint, that means, the stateful TCP session to the endpoint is failing. One reason may be the ns mode 'MBF' is set to enable. This issue depends upon deployments and might occur only on certain versions of Citrix ADC.
+To resolve this issue, you should disable MBF ns mode or bind a netprofilewith the netprofile disabled to the servicegroup.
+Note: If disabling the MBF resolves the issue, then it should be kept disabled.
 
-As general support, while raising issues please provide following for faster debugging.
+## Customer support
 
-Do a curl/ping from ADC to endpoint and do some captures.
+For general support, when you raise issues, provide the following details which help for faster debugging.
+cURL or ping from Citrix ADC to the endpoint and get the details for the following:
 
-For node:
+For the node, provide the details for the following commands:
 
 1. tcpdump capture on CNC interface on nodes
    ```
@@ -95,7 +85,7 @@ For node:
 5. output of "iptables -L" on the node.
 
 
-For ADC:
+For ADC, provide the details for the following show commands:
 1. show ip
 2. show vxlan <vxlan_id>
 3. show route