Kubernetes Dashboard - Quick Setup

Overview of this Guide

This guide is a walkthrough to install and get started with RealOpInsight and Kubernetes in a few minutes.

The installation will be based on the latest Docker distribution. For other installation options, i.e. using binary packages or a virtual machine image, please read the Installation Guide.

At the end of this guide you will see how RealOpInsight provides easy yet powerful alternative Kubernetes dashboards for service operations monitoring.

Before you begin

The below steps assume that:

  • You have a Kubernetes cluster or Minikube setup and ready to use.
  • Your have access to the Kubernetes API from the environment where you are installing RealOpInsight. This installation environement can be, a namespace of your Kubernetes cluster or a remote machine where you have access to the Kubernetes API via kubectl.
  • If, like the rest of this guide, you’re planning the installation on a computer where you have access to the Kubernetes cluster via kubectl you can enable a proxy access to the Kubernetes API from your local machine as follows:

    $ kubectl proxy --port=8001
    

Start a RealOpInsight Docker Instance

The following command will start a RealOpInsight Docker instance in background.

$ docker run -d \
    --name realopinsight \
    --network host \
    --publish 4583:4583 \
    rchakode/realopinsight

This will bind the RealOpInsight web interface port (4583) to the local machine.

Inside the container, binaries, logs, and many other configuration files are located at /opt/realopinsight/.

Connect to RealOpInsight Interface

The RealOpInsight interface will be available at: http://127.0.0.1:4583/realopinsight/.

The default administrator credentials are: admin/password.

For a production setup that must be kept secure the default password must be changed at your first connection.

Integrate Kubernetes as Monitoring Data Source

You can proceed as follows in order to integrate Kubernetes as a monitoring data source:

  • Log into RealOpInsight as administrator (default credentials: admin/password).
  • Select the menu Monitoring Sources to fill in the monitoring source settings.
  • Set the field Monitoring Source Type to Kubernetes.
  • Set the field Monitor API Base URL to http://127.0.0.1:8001/ (assuming that you started a proxy access to Kubernetes API with default options).
  • Leave the other fields as is.
  • Click on the button Add as source.
  • When prompted, select Source0 as Source Id.
  • On success you shall see a message confirming that.

For this quickstart guide a single source is enough, but you can repeat the above steps to add as many monitoring sources as you want to integrate with RealOpInsight.

Introducing Kubernetes Namespace Application Dashboard

After a successful configuration of a Kubernetes source, RealOpInsight automatically discovers all services in Kubernetes and grouped them by namespace in what is called Namespace Application Dashboard. A Namespace Application Dashboard is defined by the set of all services belonging to a given namespace in Kubernetes. It’s organized as a dependency graph where each service is bound to its related pods, which each is in turn bound to the containers that compose it. See an illustration on the figure hereafter.

By this way RealOpInsight provides a high level, yet comprehensive view on services within each namespace. Ultimately, RealOpInsight allows you to build dashboards consisting in one or more namespace views, which you can assign to your operations teams in an effective and intelligent way, in regard of your internal operational processes and policies.

Namespace Application Dashboard

As administrator you can preview and check the Application Dashboard for any single operation view before assigning it for operations.

  • Log into RealOpInsight as administrator.
  • Select the menu Manage Operations Views to see the list of managed views, it shall contain entries related to the namespaces you have in Kubernetes sources you already configured. Each entry is prefixed with the Id of the monitoring source (e.g. Source0:kube-system for namespace kube-system in Source0.
  • Select the menu Preview.
  • Select an entry in the list of managed views (e.g. select Source0:kube-system for this tutorial).
  • Click on Apply to display the Application Dashboard.
  • Click on the button to refresh the views (service map, service tree, message panel).

In our example there is no problem on pods. If that was the case, you should have seen a related message in the message console, as well as the tree view and the map updated to identify and highlight the impact of the problems on services.

Executive Dashboard

As illustrated on the figure hereafter, the Executive Dashboard can consist of no, one, or many namespace items. It’s organized like a grid with configurable number of columns. The displayed items should have be explicitely assigned to the logged operator prior to the login. Each item is the grid provides a summary of the status of microsservices within the associated namespace.

The rest of this section will describe how to create Executive Dashboards and use them.

Create a Operator User

  • Log into RealOpInsight as administrator.
  • Select the menu New User.
  • Fill in the user information:
    • Password must have at least six (6) characters in two classes (upper/lower cases, digits, special characters, etc.).
    • Ensure to select Operator as User Role.
    • The property Dashboard Tiles Per Row allows to set the number of columns for the Executive Dashboard.
  • Click on Submit to save the changes.

Assign Operations Views

  • Log into RealOpInsight as administrator.
  • Select the menu Manage Operations Views.
  • Select an operator in the user selection list at left.
  • Select one or several items in the list of business applications at the right.
  • Cick on Assign to apply the changes.

Operate Executive Dashboard

  • Log in as operator
  • On login the operator Executive Dashboard will be displayed with the items assigned to him, as shown on the screenshot below.
  • You can select a business application tile to open the associated Application Dashboard.
  • When an Application Dashboard is active, you can select Executive View to go back to the Executive Dashboard.

This is the end of this quickstart of RealOpInsight, please follow the below links to move forward with advanced use.