From cf4d5e5244d878a0651e956f555dc2a8b426da10 Mon Sep 17 00:00:00 2001 From: Madhu Rajanna Date: Tue, 5 May 2020 14:39:20 +0530 Subject: [PATCH] doc: Update github issue template Added more details about required versions and what logs need to be included when raising the bug Signed-off-by: Madhu Rajanna --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fac7a3f2b..b3ec591c3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,10 +10,13 @@ A clear and concise description of what the bug is. # Environment details # -- Image/version of Ceph CSI driver -- helm chart version -- Kubernetes cluster version -- Logs +- Image/version of Ceph CSI driver : +- Helm chart version : +- Kernel version : +- Mounter used for mounting PVC (for cephfs its `fuse` or `kernel`. for rbd its + `krbd` or `rbd-nbd`) : +- Kubernetes cluster version : +- Ceph cluster version : # Steps to reproduce # @@ -31,6 +34,35 @@ Describe what happened A clear and concise description of what you expected to happen. +# Logs # + +If the issue is in PVC creation, deletion, cloning please attach complete logs +of below containers. + +- csi-provisioner and csi-rbdplugin/csi-cephfsplugin container logs from the + provisioner pod. + +If the issue is in PVC resize please attach complete logs of below containers. + +- csi-resizer and csi-rbdplugin/csi-cephfsplugin container logs from the + provisioner pod. + +If the issue is in snapshot creation and deletion please attach complete logs +of below containers. + +- csi-snapshotter and csi-rbdplugin/csi-cephfsplugin container logs from the + provisioner pod. + +If the issue is in PVC mounting please attach complete logs of below containers. + +- csi-rbdplugin/csi-cephfsplugin and driver-registrar container logs from + plugin pod from the node where the mount is failing. + +- if required attach dmesg logs. + +**Note:-** If its a rbd issue please provide only rbd related logs, if its a +cephfs issue please provide cephfs logs. + # Additional context # Add any other context about the problem here.