From a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Wed, 24 Jul 2024 20:09:42 +0200 Subject: Improve documentation This commit ports our documentation to Sphinx. The reason for this is straightforward. We need to improve both the quality and the accessibility of our documentation. Hugo is not capable of doing this, as its primary output format is HTML. Sphinx builds plenty of high-quality output formats out of the box, and incentivizes writing good documentation. --- docs/queries/kubernetes.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/queries/kubernetes.rst (limited to 'docs/queries/kubernetes.rst') diff --git a/docs/queries/kubernetes.rst b/docs/queries/kubernetes.rst new file mode 100644 index 0000000..f8d8984 --- /dev/null +++ b/docs/queries/kubernetes.rst @@ -0,0 +1,29 @@ +Kubernetes tips +=============== + +Find top pods by CPU/memory +--------------------------- + +.. code:: bash + + $ kubectl top pods --all-namespaces --sort-by='memory' + $ top pods --all-namespaces --sort-by='cpu' + +Find top nodes by CPU/memory +---------------------------- + +.. code:: bash + + $ kubectl top nodes --sort-by='cpu' + $ kubectl top nodes --sort-by='memory' + +Kubernetes cheat sheet +---------------------- + +`Open Kubernetes cheat +sheet `__ + +Lens IDE +-------- + +`OpenLens `__ -- cgit v1.2.3