Getting Started - Kubernetes

Overview of this Guide

This guide is wallthrough to get started with RealOpInsight in a few minutes using a Docker image and an integration with Kubernetes. For other installation options, i.e. using binaries or a virtual machine image, please refer to our complete Installation Guide.

Before moving forward, note that the below steps assume that:

  • You have a Kubernetes cluster or Minikube setup accessible from your local machine.
  • You can enable a proxy access to the Kubernetes API from your local machine as follows:
$ kubectl proxy --port=8080

Start a RealOpInsight Docker Instance

The following command will start a RealOpInsight Docker instance:

    $ docker run --network="host" -p 4583:4583 -p 2283:22 -i -t rchakode/realopinsight /bin/bash

This will start a container and bind the following:

  • Access to RealOpInsight Web Interface through port 4583 (http://127.0.0.1:4583/realopinsight/, default credentials: admin/password).
  • SSH access to the containter through 2283 (ssh -p 2283 ubuntu@127.0.0.1, password is ubuntu).

Installation Summary

Once the container is running:

  • The RealOpInsight Web Interface is available at the following URL: http://127.0.0.1:4583/realopinsight/. The default administrator credentials are admin/password. For a prodution setup and must be kept secured the default password must be changed as quick as possible.
  • You can open an SSH access to the Docker instance as follows: ssh -p 2283 ubuntu@127.0.0.1 (password is ubuntu). Inside the container, binaries, logs, and many other configuration files are located at /opt/realopinsight/.

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:8000/ (assuming that you started a proxy access to Kubernetes API as described previously).
  • Leave the other fields as is.
  • Click on the button Add as source.
  • When prompted, select Source0 as Source Id.
  • Click on Apply to save the changes.
  • 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.

Introduction to Kubernetes Service Operations Views

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 Operations View. A Namespace Operations View (NOV) 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.

Service Operations Console (SOC)

Please read Overview on SOC if needed.

As administrator you can preview and check the Service Operations Console for any single operation view before assigning it for operations.

  • Log into RealOpInsight as administrator.
  • Select the menu Manage 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 view in service operations console.
  • Click on the button to refresh the views (service map, service tree, message panel).

On our example we can see that there is a problem with a Prometheus pod, which, as shown in the message panel, has been evicted due to low resource on the node). The event impact is easily is highlighted using the tree view, the service map and the event console.

Business Operations Dashboard (BOD)

Please read Introduction on BOD if needed.

Unlike SOC, administrators do not have access to BODs but only specific users defined as Operator in RealOpInsight. Each operator has access to a single BOD that acts as its home page on login. A BOD can consist of no, one, or many operation view items organized within a grid with configurable number of columns. As administrator, you need to create BOD operators and explicitly assign operation view items to them.

The rest of this section will describe how to create a operator, to assign operation view items to him, and to login and display a BOD.

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 on the BOD grid.
  • Click on Submit to save the changes.

Assign Operations Views

  • Log into RealOpInsight as administrator.
  • Select the menu Manage 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 a BOD Console

  • Log in as operator
  • On login the operator BOD will be displayed with the items assigned to him.
  • You can select a business application tile to open the associated SOC.
  • As the SOC is active, you can select Executive View to go back to the BOD.

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