RealOpInsight Ultimate Installation Guide

Overview & Requirements

As of version 2015r1, RealOpInsight Ultimate is shipped out in four types of 64-bits distributions:

  • Open Virtualization Appliance (OVA) virtual machine image based on Ubuntu Server 14.04 LTS (prior to version 2014b8, the image was based on Ubuntu Server 13.10).
  • Docker image based on Ubuntu Server 14.04.
  • Binary distributions for Ubuntu Server 14.04 and Ubuntu Server 13.10 (now deprecated). Shall work out of the box with any Linux distributions based on those Ubuntu Server distributions, subject to have Graphviz installed. Ideally, you should install the official distribution of Graphviz provided with Ubuntu Server. We can not guarantee the compatibility with other distributions.
  • RealOpInsight Ultimate is based on a built-in HTTP server that listens on port 4583.

Regardless of the distribution you chosen, the installation of RealOpInsight Ultimate should take you less than 10 minutes.

Installation via the OVA Distribution

The RealOpInsight Ultimate OVA appliance can be installed under any OVA-compatible hypervisors such as VirtualBox and VMware products.

Installation Steps

The following steps describe how to install RealOpInsight Ultimate via a OVA image under VirtualBox:

  • Go to the download page and get the latest OVA distribution of RealOpInsight Ultimate.
  • If not yet the case you’d need to install VirtualBox, see the VirtulaBox official website for details.
  • Run VirtualBox and select the menu File -> Import Virtual Appliance from the VirtualBox graphical interface.
  • Browse your file system and select the downloaded OVA appliance file.
  • Check the information and validate the importation.
  • Wait that the importation finishes.
  • Start the virtual machine and open the RealOpInsight Ultimate web interface at the following URL: http://<hostaddr>:4583/realopinsight/ (default admin credentials: admin/password).

Appliance Information

By default the appliance is configured with the following characteristics and can be modified according to your needs:

  • 1 CPU
  • 2048 MB RAM. Consider to increase this according to the number of services you want to handle. Allocating a too small amount of memory may cause performance overhead, and even crashes on high load.
  • Network: Bridged virtual network relying on DHCP for IP address. You should consider to change the network settings if you want to use fixed IP address.
  • Operating System: Ubuntu Server (13.10 or 14.04 LTS, according to the version you selected).
  • System Login: The default user/password pair to log on the server operating system is ubuntu/ubuntu.
  • Default System Keyboard Layout: en (English). You can use the loadkeys command to change this. E.g. $ loadkeys fr shall switch the keyboard layout to French.

Installation via the Docker Distribution

Here we describe basic steps to start a RealOpInsight Ultimate container using a NAT network (port forwarding). These steps do not cover advanced settings on Docker (e.g. advanced network settings and the management of systemd for permanent containers). As such manipulations are specific to each system administrator, we recommend you to refer to the Docker documentation and your locale IT & security policies for that.

To download and start the latest version of RealOpInsight Ultimate container:

$ docker run -p 4583:4583 -p 2283:22 -i -t realopinsightlabs/realopinsight-ultimate

You may append a tag option on the container name to start a specific version (e.g. realopinsightlabs/realopinsight-ultimate:2015r3.1 will start the version 2015r3.1 of the container)

As you may have noticed, the ports 4583 (RealOpInsight http service) and 22 (SSH Server) of the container will be automatically bound on the ports 4583 and 2283, respectively, on the Docker host. The container will end its start-up with a bash terminal, and will stay up until you exit the terminal.

The web interface of RealOpInsight Ultimate will be accessible via the following URL: http://<docker_host>:4583/realopinsight/. Where <docker_host> must be replaced by the hostname or the IP address of the Docker host.

Note

As of version 2015r3.1 of RealOpInsight Ultimate, the Docker distribution can be used in production. Feel free to customize the default setup options of the container – notably to take into account the requirements of your IT environment (memory, CPU, network...).

Installation via the Binary Distribution

  • Log on the installation server

  • Install Graphviz (dependency)

    $ sudo apt-get install graphviz
    
  • Go to the download page and get the latest binary distribution of RealOpInsight Ultimate.

  • Uncompress the archive, move to the distribution directory, and start the installation process:

    $ tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64.tar.gz
    # replace <VERSION> with the downloaded version
    $ cd tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64
    $ sudo ./install-ultimate-distrib.sh
    
  • When requested, you must accept the license terms in order to move forward.

  • You will be then invited to select the type of installation you want to perform.

  • Type n to continue with a new installation.

  • Once the installation comppleted, open the RealOpInsight Ultimate web interface at the following URL: http://<hostaddr>:4583/realopinsight/ (default admin credentials: admin/password).

Upgrade to a Newer Version

To upgrade your current RealOpInsight Ultimate installation to a more recent version, you do need to:

  • Get a binary distribution of the software via our download page.

  • Uncompress the archive, move to the distribution directory, and start the upgrade process:

    $ tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64.tar.gz
    # replace <VERSION> with the downloaded version
    $ cd tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64
    $ sudo ./install-ultimate-distrib.sh
    
  • When requested, you must accept the license terms in order to move forward.

  • You will be then invited to select the type of installation you want to perform.

  • Type u to start the upgrade process. This process is interactive, you will be asked to provide the version of RealOpInsight Ultimate that you want to upgrade.

Backup, Restore and Migration

Starting from version 2015r1, RealOpInsight Ultimate comes with programs allowing to backup and restore its internal settings. Backed-up settings (which include database and configuration files) can be restored on the same server or on another server, subject to have the version of RealOpInsight Ultimate on the both servers. The latter case is especially useful if you want to migrate your RealOpInsight Ultimate production environment from a server to another.

Backup Settings

The backup program is located at /opt/realopinsight/bin/realopinsight-backup. It can be used as follows:

  • Log on the server to backup and launch a terminal

  • Run the backup program

    $ /opt/realopinsight/bin/realopinsight-backup
    
  • In case of success, the program will end up by printing the path to the backup archive file. If the backup failed, check what happened and try again.

  • Copy the resulting backup file in a safe place.

Restore/Migrate Settings

The restoration program is located at /opt/realopinsight/bin/realopinsight-restore.

Assuming that you have made a backup as describe in the latter section, you can restore the resulting backup file as follows:

  • Copy the backup file to the server on which you want want to make the restoration

  • Log on the server on which you want to make the restoration

  • Perform the restoration, by remind that this step will overwrite your current database and configuration files. To avoid mishandling, the program provides you the ability to confirm or abandon the restoration.

    $ /opt/realopinsight/bin/realopinsight-restore <backup_file>
    # replace <backup_file> with the path of the backup file
    
  • Make sure that everything has completed successfully, and move to the next section to start using your new installation.

Installation directory & Log files

Log files, configuration files, and database files are stored at the following location: /opt/realopinsight/