From 750b4db7171fb2e695ca745a497536d22207dfa8 Mon Sep 17 00:00:00 2001 From: Tas Devani Date: Mon, 1 Mar 2021 12:32:38 -0600 Subject: [PATCH] Adding changes for KuberntesDashbaords --- observability/tools/KubernetesDashboards.md | 35 +++++++++++++++++++++ observability/tools/OpenTelemetry.md | 2 +- observability/tools/readme.md | 5 +-- 3 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 observability/tools/KubernetesDashboards.md diff --git a/observability/tools/KubernetesDashboards.md b/observability/tools/KubernetesDashboards.md new file mode 100644 index 0000000000..9d11168055 --- /dev/null +++ b/observability/tools/KubernetesDashboards.md @@ -0,0 +1,35 @@ +# Kubernetes UI Dashboards + +This document covers the options and benefits of various Kubernetes UI Dashboards which are useful tools for monitoring and debugging your application on Kubernetes Clusters. It allows the management of applications running in the cluster, debug them and manage the cluster all through these dashboards. + +## Overview and Background + +There are times when not all solutions can be run locally. This limitation could be due to a cloud service which does not offer a robust or efficient way to locally debug the environment. In these cases, it is necessary to use other tools which provide the capabilities to monitor your application with Kubernetes. + +## Advantages and Use Cases + +- Allows the ability to view, manage and monitor the operational aspects of the Kubernetes Cluster. + +- Benefits of using a UI dashboard includes the following: + - see an overview of the cluster + - deploy applications onto the cluster + - troubleshoot applications running on the cluster + - view, create, modify, and delete Kubernetes resources + - view basic resource metrics including resource usage for Kubernetes objects + - view and access logs + - live view of the pods state (e.g. started, terminating, etc) + +- Different dashboards may provide different functionalities and the use case to choose a particular dashboard will depend on the requirements. For example, many dashboards provide a way to only monitor your applications on Kubernetes but do not provide a way to manage them. + +## Open Source Dashboards + +There are currently several UI dashboards available to monitor your applications or manage them with Kubernetes. For example: + +- [Octant](https://github.com/vmware-tanzu/octant) +- [Prometheus and Grafana](https://prometheus.io/docs/visualization/grafana/) +- [K8Dash](https://github.com/indeedeng/k8dash) + +## References + +- [Alternatives to Kubernetes Dashboard](https://octopus.com/blog/alternative-kubernetes-dashboards) +- [Prometheus and Grafana with Kubernetes](https://tanzu.vmware.com/developer/guides/kubernetes/observability-prometheus-grafana-p1/) \ No newline at end of file diff --git a/observability/tools/OpenTelemetry.md b/observability/tools/OpenTelemetry.md index f2452c6f14..3877084512 100644 --- a/observability/tools/OpenTelemetry.md +++ b/observability/tools/OpenTelemetry.md @@ -29,7 +29,7 @@ Apart from features like adding custom attributes, sampling, collecting data for ## Current Status of OpenTelemetry Project -OpenTelemetry is a project which emerged from merging of OpenCensus and OpenTracing in 2019. Although OpenCensus and OpenTracing are frozen and no new features are being developed for them, OpenTelemetry has backward compatibility with OpenCensus and OpenTracing. Some features of OpenTelemetry are still in beta, feature support for different languages is being tracked here: [Feature Status of OpenTelemetry](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md). Status of OpenTelemetry project can be tracked [here](https://opentelemetry.io/project-status/). +OpenTelemetry is a project which emerged from merging of OpenCensus and OpenTracing in 2019. Although OpenCensus and OpenTracing are frozen and no new features are being developed for them, OpenTelemetry has backward compatibility with OpenCensus and OpenTracing. Some features of OpenTelemetry are still in beta, feature support for different languages is being tracked here: [Feature Status of OpenTelemetry](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md). Status of OpenTelemetry project can be tracked [here](https://opentelemetry.io/releases/#project-status). ## What to watch out for diff --git a/observability/tools/readme.md b/observability/tools/readme.md index 9c55ae9d34..64dcab6c65 100644 --- a/observability/tools/readme.md +++ b/observability/tools/readme.md @@ -3,11 +3,12 @@ There are a number of modern tools to make systems observable. While identifying and/or creating tools that work for your system, here are a few things to consider to help guide the choices. - Must be simple to integrate and easy to use. -- It must be possible to aggregrate and visualize data. +- It must be possible to aggregate and visualize data. - Tools must provide real-time data. -- Must be able to guide users to the problem area with suitable, adequete end-to-end context. +- Must be able to guide users to the problem area with suitable, adequate end-to-end context. ## Choices - [Loki](./loki.md) - [OpenTelemetry](./OpenTelemetry.md) +- [Kubernetes Dashboard](./Kubernetes-Dashboard.md)