aboutsummaryrefslogtreecommitdiffstats
path: root/docs/onboarding/tools.rst
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2024-07-24 20:09:42 +0200
committerGravatar Johannes Christ <[email protected]>2024-07-25 20:06:54 +0200
commita4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch)
tree183318852234388654c99514e45f095af8c21676 /docs/onboarding/tools.rst
parentAdd link to DevOps Kanban board in meeting template (#420) (diff)
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.
Diffstat (limited to 'docs/onboarding/tools.rst')
-rw-r--r--docs/onboarding/tools.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/onboarding/tools.rst b/docs/onboarding/tools.rst
new file mode 100644
index 0000000..811f1ad
--- /dev/null
+++ b/docs/onboarding/tools.rst
@@ -0,0 +1,50 @@
+Tools
+=====
+
+We use a few tools to manage, monitor, and interact with our
+infrastructure. Some of these tools are not unique to the DevOps team,
+and may be shared by other teams.
+
+Most of these are gated behind a Cloudflare Access system, which is
+accessible to the `DevOps
+Team <https://github.com/orgs/python-discord/teams/devops>`__ on GitHub.
+These are marked with the ☁️ emoji. If you don’t have access, please
+contact Chris or Joe.
+
+`Grafana <https://grafana.pydis.wtf/>`__
+----------------------------------------
+
+Grafana provides access to some of the most important resources at your
+disposal. It acts as an aggregator and frontend for a large amount of
+data. These range from metrics, to logs, to stats. Some of the most
+important are listed below:
+
+- Service Logs/All App Logs Dashboard
+
+ Service logs is a simple log viewer which gives you access to a large
+ majority of the applications deployed in the default namespace. The
+ All App logs dashboard is an expanded version of that which gives you
+ access to all apps in all namespaces, and allows some more in-depth
+ querying.
+
+- Kubernetes Dashboard
+
+ This dashboard gives quick overviews of all the most important
+ metrics of the Kubernetes system. For more detailed information,
+ check out other dashboard such as Resource Usage, NGINX, and Redis.
+
+Accessed via a GitHub login, with permission for anyone in the dev-core
+or dev-ops team.
+
+`Prometheus Dashboard <https://prometheus.pydis.wtf/>`__ (☁️))
+--------------------------------------------------------------
+
+This provides access to the Prometheus query console. You may also enjoy
+the `Alertmanager Console <https://alertmanager.pydis.wtf/>`__.
+
+`King Arthur <https://github.com/python-discord/king-arthur/>`__
+----------------------------------------------------------------
+
+King Arthur is a discord bot which provides information about, and
+access to our cluster directly in discord. Invoke its help command for
+more information (``M-x help``).