diff --git a/assets/docs/troubleshooting/troubleshooting.drawio b/assets/docs/troubleshooting/troubleshooting.drawio new file mode 100644 index 00000000000..b7ee63dffe2 --- /dev/null +++ b/assets/docs/troubleshooting/troubleshooting.drawio @@ -0,0 +1 @@ +7V1bl6K4Fv41tc6TLm4iPNal7Zkz1TN1+jbT8zILJSpTSGjAuvSvPwkQ0GxKI41AFanVq5WIEdjZt29fcqFfb57eR064/oBd5F9oivt0od9caJqmmBp5oSPP2YiqWWY2soo8Nx8rBz55P1A+qOSjW89F8d6JCcZ+4oX7gwscBGiR7I05UYQf909bYn//V0NnhcDAp4Xjw9E/PTdZZ6OWNi3Hf0Heas1+WTXt7JONw07O7yReOy5+3BnS313o1xHGSfZu83SNfPr02HP589fnP/3be/P9f/8Xf3e+XP32+fevo2yy2SlfKW4hQkFSe+o/vHv9D3z7WY/f27cfdBu5P/7Ov6I8OP42f175vSbP7AFGeBu4iE6iXOhXj2svQZ9CZ0E/fSRrhoytk41PjlTyVvBK8zt6QFGCnnbolF/5e4Q3KImeySlP+6spX4VmfvhYUlTV7HxwvUNObTLNR518Ha2KuctnRd7kj+sEqminPrqdx/QvSpLnnFecbYLJEI6SNV7hwPFvMQ7z85Y4SPLTVHqMAveS8gQ5nvt4cZ8NzTyfTUyO8vMtchQnEb4vlr1GR9gaphfkO3PkXzmL+1V6odfYxxH5KMABolO5hI/yeykv7l05eiKxY7yNFujAeXouHZxohQ7Nl8sfen0Hl06EfCfxHvblQOPLQAfL4BO5g+RCM50NZY5gHofFs6pcG+pxttpdB5SMK9+J45yK+0RWeSKfiyONfY60qjiygiGNc7GjCehwmX7pDrupJkEX9HJMn1zH1Twi71b0XbQNAi9YXegzSKA13sy38XHi7D1uSqmZs/F8+lx+Qf4DSryFU0FCx/dWATlYELqgqJqO5CfTi7sxy6PPqXAYGe2RVq2UthW0tc5FWxWqqWsnoL+0WCDCCOQTz4HE/c2iH5FnFtGTJIkPkLgYaIPG370f//y9tK42X+Yf/v78zf/hGVpxCyWJb1Do4+cNvXPyXUrKeJvRW5Jyh5Sa0iG7VpLSAKT8HQOCHTcv2reefs5eevKSv5gZRt5/o98aT/Kjm6d8kvTgmR0E5Hn/tXuw8y16WH4tPWLfyy6UXcCFpk/fXZrv2Ip+aZw9blF/QtRwM6HhdojFjxpubCHn61PYjstnusNeKjLYKXi5jMl17flG7BzGYdN9HtJ1jjeyZ5B/68BEPDMWN8Emyh4SmIisS+d557SQnhADTiweUn3mnADmzNTkwt/GVLQBLZpKXufB8cjyp8tndty0Haws1s2+yWJoFr8SWdykJ1tDMh+WsKUkfVni1pXt9YXzIaF7VDhPeiucC2Gc/7RdUzZPeENJEZPNTUneqWTFHhlJIizcMCtOBFnRejWsWGDjJ/OiVs9OaooXLcCLdxEKM5Toft8e6gi3WxL+21mT78zZ7Pr6jKYLT5HuTRcVQgLkrfuflDrrFGNVvAAarM9kDabX6G9SrgixBAwOGanC2O35KA1jKd9QfID1XqPmO6rYj2glopSuTLNKrxWfMO1aatRvO7r2mHYtFeq3PX3aipkqqhvVE0EErUUQgQtSFlHKU5UjP5HesqGqwpjWpetmA1D8KhXydihKkxelhiIoSpsIg1XT7tWCr2fwMtqQg73zMlRRj5+xeQ/9DMNuys845rCcW5RCR+NCM6iTsZ2jReKXjsbIC5aQUcmiD+lbb5OmOV1R0UQMTv8yNy/nOEnwZueDW8oYdzj2Eg/TEzae66YM/QLHXFDtQv/IKemPXMZhloZFRxx2sPSeqDC4yq/jZp0kNH/rkj4wbbZwA3XsLXCw9IjQiMYLcknazHUSh7zQ8Zi+4iB9OyL3FIWjB+zTFJrZhBp/M/IANh4RIPmHqmaNQ2oa7xvct9uF55I5lWsyDy6Mpp17maV/UBMU98jsch8tE/ZUdh5XlIno/GnhiNwNm8VFS2ebuhpEOSQ3XkSeTPYlP4k4gaefU+dMeEdNgzrHgiqHjTWvcuwX1vieRaD4XpzI9S3X93Gbyjrunra5vpnKOLK+ncJEph/trR86OH5wHSce42hFFxS1n6GDK7lBcsMxD8NQO+YGiMp9iVG+8keUJUY4RJGT0McoYbeSkqbVN9hNk7Bbo7BbG0GtrpxFrb+4m8H7eHVxN36itnE3DeJuThj6z6VZAYMdGyfwloha1jI7srpwhIv6F3Gu7sQuhOgYXam1s47QMh01v29padHVvvW18pL1dp4bXalNmRuY1K6KEKKX5GSRy8LMzD/Xsxc2L1tCM++pRHF31pOzWBCTiBKNlmxR3idCOz2HrDJqGOYXTeZ32FwHlMfbQn5V1ezduoKpfaVNBiVHYaXlydVpKYSshDhoswnj++cjMswiOoXIyZqa6kQlUxaXpD5A6h7wM8TVpHk+rKi4Jmyen5i+2WZYnC82qp3AaXJRIZClf2b7nP2cZMj2GbJpxhLNN2H6toeMNeUCQTpf6i7KV/xERsvJmDqEFIeXs9BAwUENGKozfdXf3ANV4/Mj6+or/VhV2bn5SuYCDbz4R6voqXEQk+olP3JsZPDJc8J5lbp6ZKZzMyREaNpA/rionKZ7QZw49HJ5KPBjTuUU7nPT+vtBo3yW0Tf8R5cFnUOX6aKui97fkk6Lz3CvW28PGLRtiQ7h2E4k+jZcRQ6N1YySNRoRARfTZBUg37+kp72QrTFkQc+jv2bn/XB0mDk8XEF/ClLUpKDvFvydigr6EzGqDgW9Makr6HmMip/ozIKeyQOJ/Q42V0qYH08FtzrEjI262BY/0URXxsrOn9Yud0IE+WuWMXW52ukfJ7s9CvSPm3Ze+G9oUtYOPPAtGkdgjN9DUQvSUuuaPmAiXmafW7jCtNQvcZYWyKRr7Llo4ciE/4OlGz0QrDAgxFOwuv2fVJwCHXN6QF8YX7gheoziR0pWyyXS3VES+AVQqAcEhuj/pwRHKWUVSUpxUlqdF18ZEDkuW5ChJ/IAiT2Yki+n7/VFmr5LO65sQ9dJ6Hlltv5AcFoe7+8BHSFO+xVF3jI1OvmaioFQiee2sginOzLJZOqh43eGaDIMM5N76FTyeLrJp2oK58Iox2Y6s1c5kUmfXSUyNM1XwmBNj5M+Vb0pxuL3EmidsSB6Ku4EIuk5HEFxurc4JxCP+1xm7VEW1BSXo/hADE/ePejeY59AyE0S66ISP+sBZ0H8TNokr9MmMURtkv4mSfLN9i3FHts7f1yHp7pVKUemPbe1IvOZB57PbIjmM0/66z6Yk7OwKl/w3DGrQsRaQmjDSssQ5lVDdJPm7lPgJnVrD8BEfP31uflRZoi/FWv1RG7pMIG7Ic3GO+p2y33ZJzIcNHhdJrptrXHifmwd6jLLaIQ7wbR2l8ndDMOTvDpcXhWFc1jwo4e8yu9p0pAm5Xc46dZHZHtRSJv0REZ7M1WLwlkWp7LqqEVeHQT0asI44vB49c3AqIydjvNdf1v9DAJGNWFEWJqzr7OLZI+tzQm/5pvxDA1+l2il5T0STBii/5ZlWV/ffYGZTXT/BI9yl3L59S9NZjYdymzqQZa2CaPBV1svLeTmk2SUOcuwj5G/pBcT0NO26V5EXlLRCj2CY2XFRbHdu/JIrjxdLC9L5Ledh9OHdQBDjdI0fZUdYc3+5tfwgIx9uIWFMCAD2KnlnmQmjAtKA3NYeKkpGqc37d5asHzbA3vaCHsCC1ZtOfRowtDj4AsGgSlaEKUzE4RBdRVdL4hIS2156UyUFOS7CJW7fnRHQVhhJvXgsPSgcGka4/Ye6kG+/Xnt7Qj4iaYt56tNNcCPuSTVlPdOgh6d50PtZ2T3mcMqswcCFwaUZOVhgxTWO69mm8LYhbRdeTIZndexTSGMKi2fYTW7YMr2qOVj9bdZLWh2UbeDIoDkAOud2/SpaBKU9ae9vYJKsTCG0pZe/Kfk1dlQcRnMY/oie/OJuKNm5zGNqUw570woNy1c++st8kENtf7udcDBaFloWtBflEHA+kHAVwjfCBsx0/6WBgOGVOoyJIhcFBzaFkNC/54BOLyRco03IVnAQUUehkR0XrBZQNfE7hEdS3aveYlawKfoHp2xZPuaN5I1Mwh9BjjIaDmX1JIwWaMe2Wu0MEWrlRjy3cdqJT5Tpmxm+bNbjZTNLNtiSZj4KUNIzfVD7INJKbMThy50rcaFbr7cR8p4Otlb8K8SeePr1eBML0hhssDTsAE7LaQnxBW3xfo88OLByH0YYQiC+wItnUivoVGlwO5e+jWt+zU9iWYKSwyrv1vhQsepdjiTt9LATGe20myYWSlhIUaL/iXC2jCQMvisHWAZdw/f2bIfwxuB7yzRnaKZIO2huuKTb+qbs/zW7cLmbGPqSnZcGLzLKcyR2mkcOSwHszGOlJGqrlI7GmYshg8fx3JO7KLZpmfG+1N6Y/i53jJ+bsvtFIYDlVSfJ8yQJyYxtsiQfKVafYYEM7W9G5sNA1q/BqsIxTRqtcDB0lu9ENJa4ChCi0QGtA7mdU87LxS3YUBLhiwbLKfqPnPflh0bjpOpe0ZU2UKRsPTxbMXuuUpV5A7Aw7FVD/qEx1GZ/jqPb8hWVRUYgZBA6bCAUnGWPDHS3iJQavOhi9osCWdqGc9RFRi7kEryVQYFT2WYFnWYzWue5opGpy3XqKmKDC0M3Kq0RVVY4TD2kSX5YkCdL46pXWZjttyPVlVknc3QzUphnmRYmzQrz8uSMCyRNaThoeobL17gBxRVFXnznWjKym7ZjuZI2MLuPNtQVSCqLeMWDQLiPSCxKvO0hQHxPpBLk67L2/D1C/0q4IOcaPB0WbFi82tf2AcB+q9taFuVsMDAYYGC047zJNObPeTJstYLBN5PZkqOvTWlbaxOlbXggwcGhBWldmIHjg5b9KtmUz361SmPMZybJ9lj3uFJ5gg61BKO0DIdNb9vcZKyYxKSS7ukV6LNVl6y3s7HC7whB/fbOYoClKB4FHurmF4PuTpvQQ5R9JAiCvkkzMEEn/vZpzNnB3N4sZ+cRB2OoA5W56Woqlaxf6cU+YMS+YWIEXCO+ptkACS1xbs0tWW+1XI5v6rBAM0NCn1Mn2y1SN4Dgc+kHHQviBPHp5TEAdQVH8lvVSqIgSBYAHDsg3SX+7a+FQTrVHO7RR9Y56vswE5WtdNVrJZ7nKtaxc4QsraAByY631Gn6Kgo7dbh2q3iAKJ2Yr56i3YrgOKntdtQgZla7iKg6nKHzwExZeV5JmTJg2XRPeRIsMFnXYbseoNPVdegMSOzilrD98qB7uwkQ9pJAxLJP5v8wATGK5DKqt1YXZ/dtlw2oJ0kU/0a9E/7IHeh6pWpftmnfKpfL8gle32+FaCU6bDj2o6J4R5Cqnxjd9ogop6203mjVG+73MiQJbNDT/VjnCbAkydaoF2WANpNlQBqWus8CdM+ZJiDNyP17lsoGbJUc/Du+wnCc3Ka8OxyT7Ta7jucqXX3Xe4cP3imFPcyWPSgh0wJIh21t8DReN1ptG3RsCvfYcrLgD7WMMJzH20gpIaeFiik95CsswavayeS7V0PRzSM7nPaJjLI3APp25Y/+XM9tfssfEHWXP0mT0fbRZ1d+EK0+zaFuDeI/HcfkGVPLmaOt0npX+ZyefxTKcz/klsaxz7hozyNmfzAjFyFOyKHm23gJYRKM8J5EXL/8YIHIr7J8Y9k5M61+2cbG6OP/9ihFn8NraePjz+Sr461WgZ3lzC9+RP9EZng3DdlIMtXmlEGPQEKJ+KS/USgsENfV6st2cFMoMXR2SU7BKAAd+Xb2pL3kyvyTxmnQMR18XoxIWddp59kx/tj1qT6bDUd5WdgZ+ev3NwqN8auBJy9Pzf5l7JkSO9o87QiYno9noebYIwe0pW9KzOoxCSWvH9LufYOx15aD0MEAU4SooNeZGfCb8v0b2eOy9z2T6ikgZ5AiCKPkJC+vyHU8sIY3ZVDV0Sf+l5AGDoI0p0pUpZ04jA7WHpPVOSxs+gUAT2OnzdzTG+GTLLxAidBWnHROHJRxC7YRUtnm+q7PV/mdrvwXKqbye/GuBRAO1qME0Dm9PLKnkGVpaR/5/RfdG776UlFV5lJhcbi/eAGNZYsyelqq6262FF6tMN3XWs+8zTN12GHmvq5s/yeynCms2s+2QyjBzhDpyivJrrNuXAmSb66R8QimXKqaUAJ7mR9O887p+UGJLyposkO53pOc89TFI7mzidvsktoWGLAuNAFLdtUaG31IqETZIl/IXYp4DzCmSECU/+YKZolBkJzsTA1X7JFN57rpvz7si1aGF/pj1wyq7HShMyv42YffFm4gTr20k3TiAiMcgTGdRJiHM7oOK0iJ9eTvh1RECYcPWB/RAkxoc31ZrkF6ucfqpo1DinMLWRw7tzLLP07YGAyy9pHy4Q9lZ3HFWWW32EjmNicyY1H94DLvuQnESe+9XOasto+z7IGarvYiwUNWTbWvCFrQhy+erV7bH89uch/apEf9aJe/yJX2X6pZSW5ea5lTg4jTCHeUgdQt/8DdhE94/8= \ No newline at end of file diff --git a/assets/docs/troubleshooting/troubleshooting_chart.svg b/assets/docs/troubleshooting/troubleshooting_chart.svg new file mode 100644 index 00000000000..bba4bf5c89e --- /dev/null +++ b/assets/docs/troubleshooting/troubleshooting_chart.svg @@ -0,0 +1,4 @@ + + + +
Start 
Start 
All Pod are
running?
All Pod are...
Can access via
K8s ingress?
Can access via...
Deployment is success?
Deployment is succ...
No
No
K8s cluster
is available? 
K8s cluster...
No
No
No
No
Prepare k8s cluster
Prepare k8s cluster
vald's chart in
your helm repo?
vald's chart in...
Yes
Yes
Add vald's chart in your helm repo
Add vald's chart in...
No
No
$ kubectl cluster-info$ helm repo list$ helm repo add vald https://vald.vdaas.org/charts
Use vald-helm-operator?
Use vald-helm-oper...
Yes
Yes
apply vald
manifest success?
apply vald...
Fix your manifest ac...
vald-helm-
operator is runnig?
vald-helm-...
vald-helm-
operator is the latest?
vald-helm-...
Yes
Yes
Yes
Yes
No
No
No
No
Retry to deploy
No
No
Upgrade vald-helm-op...
No
No
Yes
Yes
Vald Agent is running?
Vald Agent is runn...
Yes
Yes
Using Agent sidecar?
Using Agent sideca...
Agent sidecar
is running?
Agent sidecar...
Docker image
is available?
Docker image...
Storage is available?
Storage is availab...
Prepare external storage, then update manifest
Prepare external sto...
Verify your manifest
Verify your manifest
Yes
Yes
No
No
Docker image
is availeble?
Docker image...
Try to get docker image
Try to get docker im...
Try to get docker image
Try to get docker im...
No
No
No
No
Yes
Yes
No
No
Yes
Yes
Yes
Yes
No
No
No
No
Yes
Yes
Your CPU
applies AVX2?
Your CPU...
Build docker image by yourself and use it
or
Prepare cluster w/AVX2
Build docker image b...
No
No
Yes
Yes
Verify your manifest
Verify your manifest
Using Filter?
Using Filter?
Yes
Yes
Filter Gateway
is runnig?
Filter Gateway...
Docker image
is availeble?
Docker image...
Verify your manifest
Verify your manifest
Yes
Yes
Vald LB
Gateway is
 running?
Vald LB...
Yes
Yes
No
No
Filter
Component
is runnig?
Filter...
Try to get docker image
Try to get docker im...
No
No
Yes
Yes
Docker image
is availeble?
Docker image...
Yes
Yes
No
No
Try to get docker image
Try to get docker im...
Verify your manifest
Verify your manifest
No
No
Yes
Yes
No
No
No
No
Ingress config
is correct?
Ingress config...
Docker image
is availeble?
Docker image...
Verify your manifest
Verify your manifest
Try to get docker image
Try to get docker im...
No
No
Yes
Yes
No
No
No
No
Yes
Yes
Vald
Discoverer
 is running?
Vald...
Docker image
is availeble?
Docker image...
Try to get docker image
Try to get docker im...
No
No
No
No
Yes
Yes
metrics-server
is running?
metrics-server...
Yes
Yes
Deploy metrics-server
Ref
Deploy metrics-serve...
No
No
Verify your manifest
Verify your manifest
Yes
Yes
Yes
Yes
Vald
Discoverer
 is running?
Vald...
Yes
Yes
Docker image
is availeble?
Docker image...
Try to get docker image
Try to get docker im...
No
No
No
No
Verify your manifest
Verify your manifest
Yes
Yes
Yes
Yes
Any problem
except this chart?
Any problem...
Yes
Yes
Let me know about your problem.
Slack
Let me know about yo...
Yes
Yes
No
No
Yes
Yes
$ kubectl get pods -o wide$ kubectl get ingress
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/support/faq.md b/docs/support/faq.md index f30cc65ba52..ffa46702aac 100644 --- a/docs/support/faq.md +++ b/docs/support/faq.md @@ -1,6 +1,6 @@ # FAQ -This page answers the common questions. +This page shows the answers for the common questions. Please refer to [the troubleshooting page](../user-guides/troubleshooting.md) when you encounter operation problems. diff --git a/docs/troubleshooting/chart.md b/docs/troubleshooting/chart.md new file mode 100644 index 00000000000..7a89e877823 --- /dev/null +++ b/docs/troubleshooting/chart.md @@ -0,0 +1,16 @@ +# Troubleshooting Chart + +This page shows the troubleshooting flow chart. + +If you encounter the trouble, please confirm below chart and try to fix it. + + + +If any components output the `INTERNAL` error log, let us know the detail. + +--- + +## Related Document + +- [Troubleshooting](../troubleshooting/troubleshooting.md) + diff --git a/docs/user-guides/troubleshooting.md b/docs/troubleshooting/troubleshooting.md similarity index 95% rename from docs/user-guides/troubleshooting.md rename to docs/troubleshooting/troubleshooting.md index 6fd1d72e582..90e10d33680 100644 --- a/docs/user-guides/troubleshooting.md +++ b/docs/troubleshooting/troubleshooting.md @@ -32,4 +32,5 @@ Please check your CPU information. ## Related Document +- [Flow Chart](../troubleshooting/chart.md) - [FAQ](../support/faq.md)