From ad2253ca1a602bee4577813ebadcc23dac3f645f Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Wed, 12 May 2021 09:11:56 +0530 Subject: [PATCH 1/4] Added tip for make start to check troubleshooting page Signed-off-by: Prafulla Mahindrakar --- rsts/community/troubleshoot.rst | 6 +++--- rsts/getting_started.rst | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/rsts/community/troubleshoot.rst b/rsts/community/troubleshoot.rst index 3b2d43aba4..79d8b4007f 100644 --- a/rsts/community/troubleshoot.rst +++ b/rsts/community/troubleshoot.rst @@ -26,8 +26,8 @@ Here are a couple of techniques we believe would help you jump out of the pandor You can run ``make teardown`` followed by the ``make start`` command. - If the ``make start`` command isn't proceeding by any chance, check the pods' statuses -- run the command ``docker exec flyte-sandbox kubectl get po -A``. - - If you think a pod's crashing by any chance, describe the pod by running the command ``docker exec flyte-sandbox kubectl describe po -n flyte``. This gives a detailed overview of the pod's status. - - If Kubernetes reports a disk pressure issue: + - If you think a pod's crashing or getting evicted by any chance, describe the pod by running the command ``docker exec flyte-sandbox kubectl describe po -n flyte``. This gives a detailed overview of the pod's status. + - If Kubernetes reports a disk pressure issue: (node.kubernetes.io/disk-pressure) - Check the memory stats of the docker container using the command ``docker exec flyte-sandbox df -h``. - Prune the images and volumes. @@ -38,4 +38,4 @@ Here are a couple of techniques we believe would help you jump out of the pandor More coming soon. Stay tuned 👀 -If the issue is still bugging you, contact us on `Slack `__. \ No newline at end of file +If the issue is still bugging you, contact us on `Slack `__. diff --git a/rsts/getting_started.rst b/rsts/getting_started.rst index d027fa228a..bae6360b3f 100644 --- a/rsts/getting_started.rst +++ b/rsts/getting_started.rst @@ -28,6 +28,9 @@ Steps make start +.. tip:: + In case make start throws any error please refer to the troubleshooting guide here ``community/troubleshoot`` + 3. Take a minute to explore Flyte Console through the provided URL. .. image:: https://github.com/flyteorg/flyte/raw/static-resources/img/first-run-console-2.gif From 26bc17c13f435be216112749515d0e994b581eb9 Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Wed, 12 May 2021 09:17:32 +0530 Subject: [PATCH 2/4] Added absolute link to troubleshooting Signed-off-by: Prafulla Mahindrakar --- rsts/getting_started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rsts/getting_started.rst b/rsts/getting_started.rst index bae6360b3f..e8b7f47d2d 100644 --- a/rsts/getting_started.rst +++ b/rsts/getting_started.rst @@ -29,7 +29,7 @@ Steps make start .. tip:: - In case make start throws any error please refer to the troubleshooting guide here ``community/troubleshoot`` + In case make start throws any error please refer to the troubleshooting guide here `Troubleshoot https://docs.flyte.org/en/latest/community/troubleshoot.html` 3. Take a minute to explore Flyte Console through the provided URL. From eb821a6d1754aeaa63d1556496884dc4831786de Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Wed, 12 May 2021 10:16:50 +0530 Subject: [PATCH 3/4] Fixed the links and incorporate copy button Signed-off-by: Prafulla Mahindrakar --- rsts/community/troubleshoot.rst | 14 ++++++++++++-- rsts/getting_started.rst | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/rsts/community/troubleshoot.rst b/rsts/community/troubleshoot.rst index 79d8b4007f..56b58a6258 100644 --- a/rsts/community/troubleshoot.rst +++ b/rsts/community/troubleshoot.rst @@ -25,8 +25,18 @@ Here are a couple of techniques we believe would help you jump out of the pandor Timed out while waiting for the Flyte deployment to start You can run ``make teardown`` followed by the ``make start`` command. - - If the ``make start`` command isn't proceeding by any chance, check the pods' statuses -- run the command ``docker exec flyte-sandbox kubectl get po -A``. - - If you think a pod's crashing or getting evicted by any chance, describe the pod by running the command ``docker exec flyte-sandbox kubectl describe po -n flyte``. This gives a detailed overview of the pod's status. + + - If the ``make start`` command isn't proceeding by any chance, check the pods' statuses by run this command + + .. code-block:: bash + + docker exec flyte-sandbox kubectl get po -A + - If you think a pod's crashing or getting evicted by any chance, describe the pod by running the command which gives detailed overview of pod's status + + .. code-block:: bash + + docker exec flyte-sandbox kubectl describe po -n flyte + - If Kubernetes reports a disk pressure issue: (node.kubernetes.io/disk-pressure) - Check the memory stats of the docker container using the command ``docker exec flyte-sandbox df -h``. diff --git a/rsts/getting_started.rst b/rsts/getting_started.rst index e8b7f47d2d..ad750baf12 100644 --- a/rsts/getting_started.rst +++ b/rsts/getting_started.rst @@ -29,7 +29,7 @@ Steps make start .. tip:: - In case make start throws any error please refer to the troubleshooting guide here `Troubleshoot https://docs.flyte.org/en/latest/community/troubleshoot.html` + In case make start throws any error please refer to the troubleshooting guide here `Troubleshoot `__ 3. Take a minute to explore Flyte Console through the provided URL. From aaecb2f05f64707558ff1ed70915281e0392820f Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Wed, 12 May 2021 10:27:48 +0530 Subject: [PATCH 4/4] Turned code block to copy block Signed-off-by: Prafulla Mahindrakar --- rsts/community/troubleshoot.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rsts/community/troubleshoot.rst b/rsts/community/troubleshoot.rst index 56b58a6258..9d9b821096 100644 --- a/rsts/community/troubleshoot.rst +++ b/rsts/community/troubleshoot.rst @@ -28,12 +28,12 @@ Here are a couple of techniques we believe would help you jump out of the pandor - If the ``make start`` command isn't proceeding by any chance, check the pods' statuses by run this command - .. code-block:: bash + :: docker exec flyte-sandbox kubectl get po -A - If you think a pod's crashing or getting evicted by any chance, describe the pod by running the command which gives detailed overview of pod's status - .. code-block:: bash + :: docker exec flyte-sandbox kubectl describe po -n flyte