Docs release 1.8.0 csi 3573 external log collection (PR2)

docs/content/troubleshooting/log_status_collect.md

@@ -10,7 +10,7 @@ To help pinpoint potential causes for stateful pod failure:
 
 1.  Verify that all CSI pods are running.
     ```
-    kubectl get pods -n <namespace> -l csi
+    kubectl get pods -n <namespace> -l product=ibm-block-csi-driver
     ```
 
 2.  If a pod is not in a _Running_ state, run the following command:
@@ -19,6 +19,7 @@ To help pinpoint potential causes for stateful pod failure:
     ```
     View the logs.
 
+
 ## Status and log collection
 To collect and display status and logs related to the different components of IBM® block storage CSI driver, use the Kubernetes commands that are found in this section.
 
@@ -29,9 +30,11 @@ For example:
 ```
 mkdir logs
 ```
-Save logs and status reports directly to the created directory by adding in the following string at the end of collection command: `> logs/<log_filename>`.
+Save logs and status reports directly to the created directory by adding in the following string at the end of the collection command: `> logs/<log_filename>`.
+
+**Important:** Be sure that the logs cover any relevant time frames for the specific issues that you are trying to debug when gathering logs from the storage system.
 
-**Important:** Be sure that the logs cover any relevant timeframes for the specific issues that you are trying to debug when gathering logs from the storage system.
+**Note:** All commands here are listed with the collection command with the `logs` folder name example. Change the folder name according as needed.
 
 ### General status and log collection for IBM Support
 Be sure to run the following steps and copy the output to an external file, when engaging IBM Support and sending log collections.
@@ -41,81 +44,62 @@ Be sure to run the following steps and copy the output to an external file, when
     `kubectl get nodes`
 2. Check the CSI driver component status.
 
-    `kubectl get -n <namespace> pod -o wide | grep ibm-block-csi`
+    `kubectl get -all-namespaces pod -o wide | grep ibm-block-csi`
 3. Check if the PersistentVolumeClaims (PVCs) are _Bound_.
 
-    `kubectl get pvc`
+    `kubectl get -n default pvc -o=jsonpath='{range .items[?(@.metadata.annotations.volume\.beta\.kubernetes\.io/storage-provisioner=="block.csi.ibm.com")]}{"PVC NAME: "}{@.metadata.name}{" PVC STATUS: "}{@.status.phase}{"\n"}{end}'`
+
+    The output should be similar to the following:
 
-    - If the PVCs are not in the _Bound_ state collect the events of all unbound PVCs. (See [Log collection for unbound PVCs](#log-collection-for-unbound-pvcs).)
+    `PVC NAME: demo-pvc-file-system PVC STATUS: Bound`
 
-### Log collection for all CSI nodepods and their containers
+    **Note:** If the PVCs are not in the _Bound_ state collect the events of all unbound PVCs. (See [Log collection for unbound PVCs](#log-collection-for-unbound-pvcs).)
 
-To collect logs for all nodepods, use the following commands:
+#### Log collection for all CSI driver node pods and their containers
 
-    nodepods=`kubectl get -n <namespace> pod -l app.kubernetes.io/component=csi-node --output=jsonpath={.items..metadata.name}`
+To collect logs for all CSI driver node pods, use the following commands:
+
+    nodepods=`kubectl get pods -l product=ibm-block-csi-driver -l app.kubernetes.io/component=csi-node --output=jsonpath={.items..metadata.name}`
 
-    for pod in $nodepods; kubectl logs -n <namespace> $pod -c $container > /tmp/logs_collection/${pod}_${container}.log;done;done
+    for pod in $nodepods;do for container in `kubectl get -n <namespace> pod $pod -o jsonpath='{.spec.containers[*].name}'`;do kubectl logs -n <namespace> $pod -c $container > logs/${pod}_${container}.log;done;done
 
 
-### Log collection for all CSI controller containers
+#### Log collection for all CSI controller containers
 
-To collect logs for all pods and containers, use the following commands:
+To collect logs for all controller containers, use the following commands:
 
-    for container in kubectl get -n default pod ibm-block-csi-controller-0 -o jsonpath='{.spec.containers[*].name}';do kubectl logs -n default ibm-block-csi-controller-0 -c $container > /tmp/logs_collection/ibm-block-csi-controller-0_${container}.log;done
+    for container in `kubectl get -n <namespace> pod ibm-block-csi-controller-0 -o jsonpath='{.spec.containers[*].name}'`;do kubectl logs -n <namespace> ibm-block-csi-controller-0 -c $container > logs/ibm-block-csi-controller-0_${container}.log;done
 
 
-### Log collection for CSI operator logs
+#### Log collection for CSI operator logs
 To collect CSI operator logs, use the following commands:
 
     operatorpod=`kubectl get pods --all-namespaces |grep ibm-block-csi-operator|awk '{print $2}'`
     kubectl logs $operatorpod -n <namespace> > logs/operator
 
 
 ### Collecting details of all CSI objects and components
-
-`kubectl describe all -l product=ibm-block-csi-driver -n <namespace>`
-
-For example:
-
-    kubectl describe all -l csi -n <namespace> > logs/describe_ibm-block-csi-driver
+`kubectl describe all -l product=ibm-block-csi-driver -n <namespace> > logs/describe_ibm-block-csi-driver`
 
 
 ### Status collection for CSI pods, daemonset, and statefulset
-`kubectl get all -n <namespace>  -l product=ibm-block-csi-driver`
-
-For example:
-
-    kubectl get all -n <namespace> -l csi > get_all_ibm-block-csi-driver
+`kubectl get all -n <namespace> -l product=ibm-block-csi-driver > logs/get_all_ibm-block-csi-driver`
 
 
 
 ### Log collection for the CSI driver controller
-`kubectl log -f -n <namespace> ibm-block-csi-controller-0 -c ibm-block-csi-controller`
-
-For example:
-
-    kubectl log -f -n <namespace> ibm-block-csi-controller-0 -c ibm-block-csi-controller > logs/ibm-block-csi-controller
+`kubectl logs -f -n <namespace> ibm-block-csi-controller-0 -c ibm-block-csi-controller > logs/ibm-block-csi-controller`
 
 
 ### Log collection for the CSI driver node (per worker node or PODID)
-`kubectl log -f -n <namespace> ibm-block-csi-node-<PODID> -c ibm-block-csi-node`
-
-For example:
-
-    kubectl log -f -n <namespace> ibm-block-csi-node-<PODID> -c ibm-block-csi-node > logs/csi-node-<PODID>
-
+`kubectl logs -f -n <namespace> ibm-block-csi-node-<PODID> -c ibm-block-csi-node > logs/csi-node-<PODID>`
 
-### Log collection for unbound PVCs
-`kubectl describe pvc <pvc-name>`
 
-For example:
 
-    kubectl describe pvc <pvc-name> > logs/pvc_not_bounded
+### Details collection for unbound PVCs
+`kubectl describe -n <pvc_namespace> pvc <pvc-name> > logs/pvc_not_bounded`
 
 
-### Log collection for pods not in the _Running_ state
-`kubectl describe pod <not-running-pod-name>`
-
-For example:
 
-    kubectl describe pod <pod-name> > logs/pod_not_running
+### Details collection for pods not in the _Running_ state
+`kubectl describe -n <pod_namespace> pod <not-running-pod-name> > logs/pod_not_running`