Merge pull request #4 from stfc/add-addon-pages

ENH: Add pages for Monitoring and K8s Dashboard.

Author: gmatthews20

docs/assets/images/accessing_kubernetes_dashboard.png

@@ -27,6 +27,8 @@ Consider a Kubernetes cluster platform deployed under azimuth, `my-binderhub`. T
 - Users in the `kubeapp-my-binderhub` have access to both services, BinderHub and JupyterHub, but no other deployments.
 - Users in the `kubeapp-my-binderhub/my-binderhub-binderhub-azimuth-jupyterhub` group have access to the JupyterHub, but not BinderHub.
 
+**Admins can add users to these individual groups through the Keycloak dashboard, hence granting them access to individual services.**
+
 ### Bulk Importing Users
 Bulk Importing/Generating a set of users can be achieved via a partial import to your Keycloak realm.
 

docs/assets/images/accessing_monitoring.png

@@ -0,0 +1,23 @@
+---
+hide:
+  - footer
+---
+
+
+## Introduction
+The Kubernetes Dashboard Web UI is available for deployed Kubernetes platforms on Azimuth. This provides a user-friendly way to administer a cluster.
+
+For usage information, see the [Kubernetes Docs](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/#welcome-view).
+
+![Example of the Kubernetes Dashboard](../../assets/images/kubernetes_dashboard_example.png)
+
+### Accessing Kubernetes Dashboards
+Kubernetes Dashboard can be accessed via the link in the cluster details
+![Access the link in Details under Services](../../assets/images/accessing_kubernetes_dashboard.png){ loading=lazy }
+
+Kubernetes Dashboard can be enabled/disabled on an existing cluster using the green <img loading="lazy" class="off-glb" src="../../assets/images/update-button.svg" style="height:1em; vertical-align:middle;"> `Update` button in details, under the Cluster Addons section.
+
+Access can be granted through the [Identity Provider](../../identity_provider/identity_provider.md).
+
+!!! Info
+    We recommend access to administrating clusters, through the Kubernetes Dashboard or through the CLI (Kubectl), be limited to users who already have admin access via your OpenStack project. This is because users with access can create, delete or modify resources in your cluster(s).</br>If granting access to other users is necessary, we recommend it is only to the Kubernetes Dashboard via the Identity Provider as this can be revoked later. Permission to generate a kubeconfig file for CLI usage cannot be granted through azimuth to non-admin users, the kubeconfig file can only be shared manually which we do not recommend.

docs/assets/images/kubernetes_dashboard_example.png

@@ -0,0 +1,40 @@
+---
+hide:
+  - footer
+---
+
+## Introduction
+Monitoring of user-deployed Kubernetes clusters is provided through a [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/oss/grafana/), [AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/), [Loki](https://grafana.com/oss/loki/), [Fluent-Operator](https://fluentbit.io/) stack.
+
+This can all be accessed through [Grafana](https://grafana.com/docs/grafana/latest/), which can be found via the "Monitoring" link in the Details page of your Kubernetes Cluster.
+
+![The link to monitoring is in Cluster Details](../../assets/images/accessing_monitoring.png){ loading=lazy }
+
+The set of Monitoring cluster addons can be enabled/disabled on an existing cluster using the green <img loading="lazy" class="off-glb" src="../../assets/images/update-button.svg" style="height:1em; vertical-align:middle;"> `Update` button in details, under the Cluster Addons section.
+
+!!! Info
+    Even if the Monitoring cluster addon is disabled, Fluent-Operator will continue collecting logs to our central logging server as per our [security compliance policy](https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/673185793/Security+Compliance).
+
+Access to Grafana can be granted through the [Identity Provider](../../identity_provider/identity_provider.md)
+
+### Accessing Dashboards
+Grafana dashboards are an easy and accessible way to query and visualize data.
+
+Azimuth provides a number of useful dashboards by default to access your logging, metrics and alerting. These can be found in Grafana under the "Dashboards" sidebar entry. New dashboards can also be created, see the [Grafana Docs](https://grafana.com/docs/grafana/latest/dashboards/).
+
+![An example of a dashboard](../../assets/images/monitoring_dashboard.png){ loading=lazy }
+
+### Accessing Metrics
+The easiest way to browse Azimuth metrics is via the Dashboards.
+
+However they can also be accessed under Drilldown → Metrics at a glance, or queried under Explore → Prometheus.
+
+![Exploring metrics](../../assets/images/monitoring_metrics.png){ loading=lazy }
+
+### Accessing Logs
+The best place to examine logs is via Explore -> Loki
+![Accessing logs via Explore - Loki](../../assets/images/monitoring_logs.png){ loading=lazy }
+
+### Accessing Alerting
+AlertManager is managed through Grafana, via the Alerting tab. Alert Rules, Silences, and Notifications can be configured.
+Alerts can also be viewed.

docs/assets/images/monitoring_dashboard.png

@@ -11,17 +11,14 @@ nav:
       - 'Overview': 'platforms/kubernetes.md'
       - 'Kubernetes Applications': 
         - 'JupyterHub': 'platforms/kubernetes-applications/jupyterhub.md'
-          # - 'Deploying JupyterHub': 'platforms/kubernetes-applications/jupyterhub.md'
         - 'DaskHub': 'platforms/kubernetes-applications/daskhub.md'
-          # - 'Deploying DaskHub': 'platforms/kubernetes-applications/daskhub.md'
         - 'ArgoCD': 'platforms/kubernetes-applications/argocd.md'
-          # - 'Deploying ArgoCD': 'platforms/kubernetes-applications/argocd.md'
         - 'BinderHub': 'platforms/kubernetes-applications/binderhub.md'
-          # - 'Deploying Binderhub': 'platforms/kubernetes-applications/binderhub.md'
         - 'KubeFlow': 'platforms/kubernetes-applications/kubeflow.md'
-          # - 'Deploying KubeFlow': 'platforms/kubernetes-applications/kubeflow.md'
         - 'HuggingFace LLM': 'platforms/kubernetes-applications/huggingface-llm.md'
-          # - 'Deploying HuggingFace LLM': 'platforms/kubernetes-applications/huggingface-llm.md'
+      - 'Kubernetes Cluster Addons':
+        - 'Kubernetes Dashboard': 'platforms/kubernetes-cluster-addons/kubernetes_dashboard.md'
+        - 'Monitoring': 'platforms/kubernetes-cluster-addons/monitoring.md'
     # - 'Linux Workstation': 'platforms/linux-workstation.md'
     # - 'Jupyter Notebook': 'platforms/jupyter-notebook.md'
     # - 'Slurm': 'platforms/slurm.md'