Installation

Before Starting

Downloads

RealOpInsight can be downloaded in four distribution forms:

  • Binary for Ubuntu Server 16.04 LTS. It shall work out of the box and requires to installed Graphviz dependency manually through apt. We can not guarantee the compatibility with other Graphviz distributions.
  • Docker image based on Ubuntu Server 16.04 LTS.
  • Open Virtualization Appliance (OVA), a.k.a virtual machine image, based on Ubuntu Server 16.04 LTS. The appliance can be installed on VirtualBox, VMware, or any other OVA-compatible hypervisors.
  • Source code that can be checked out from Github.

Regardless of the distribution selected, the installation should take less than 10 minutes.

Requirements

A minimal installation setup for a production or a demo setup would consist of:

  • vCPU: 2 (production), 1 (tests/demo).
  • RAM: 2048 MB (production), 512MB (tests/demo).
  • Network: 1 NIC with DHCP or fixed IP address.
  • Ubuntu Server 16.04 LTS Operating System.

Consider to upgrade or downgrade hardware requirements according to your needs, bearing in mind that allocating a too small amount of memory may induce performance overhead.

File Location & Logs

The installation location is /opt/realopinsight/, it contains binaries, configuration and log files.

Installation via the OVA Distribution

The following steps describe how to install RealOpInsight via an OVA image on Oracle VirtulaBox. You can easily adapt the steps if you use a VMware virtualization tool instead.

  • Go to our download page and get the latest OVA distribution.
  • If not yet the case, install VirtualBox.
  • Launch VirtualBox and select the menu File -> Import Virtual Appliance from the user interface.
  • Browse your file system and select the OVA appliance of RealOpInsight.
  • Review the default virtual machine settings. You would likely consider to change the hardware requirements according to your needs (i.e. memory, CPU, network, etc).
  • Validate the importation and wait that the process completes. That may take a few minutes.
  • Start the virtual machine and open the RealOpInsight web interface at: http://<hostaddr>:4583/realopinsight/ (default admin credentials: admin/password). Replace <hostaddr>by the IP address or the FQDN of the virtual machine.
  • The default user/password pair for terminal and SSH access is ubuntu/ubuntu.
  • The default keyboard layout isen (English). You can use the loadkeys command to change it to another layout (e.g. $ loadkeys fr shall switch the keyboard layout to French).

Installation via a Docker Image

Here are basic steps to start a RealOpInsight Docker instance using a NATed network with port forwarding.

  • Download and start the latest version of the Docker container:

    docker run -p 4583:4583 -p 2283:22 -i -t rchakode/realopinsight
    
  • You can specify a tag option to select a specific version of the container (e.g. rchakode/realopinsight:2018.r2.0)

  • This invocation will bind the port 4583 used for RealOpInsight Web Interface service, and respectively the port 22 used for SSH Server, of the container, to port 4583, and respectively port 2283, on the Docker host.

  • The container will start, prompt a bash terminal, and stay up until you exit the terminal.

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

The above steps do not cover advanced Docker settings such as network and systemd settings for permanent containers. As such manipulations are specific to each system administrator, we recommend you to refer to Docker documentation and your corporate IT & security policies.

Installation/Upgrade via a Binary Distribution

  • Log on the machine that will host RealOpInsight.
  • Install Graphviz dependency

    sudo apt-get install graphviz
    
  • Go to the download page and get the latest binary distribution tarball.

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

    $ tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64.tar.gz       
    $ cd tar zxf realopinsight-ultimate-<VERSION>.ubuntu1404.x86_64
    $ sudo ./install-ultimate-distrib.sh
    

    Replace <VERSION> with the downloaded version

  • When prompted, you must accept the license terms in order to move forward.

  • When prompted to select the type of installation you want to perform.

    • Type n to proceed with a new installation.
    • Type u to proceed with an installation update. This process is interactive, you will be asked to provide various information regarding your existing installation.
  • Once the installation comppleted, open the following link in a web browser to get access to RealOpInsight web interface: http://<hostaddr>:4583/realopinsight/ (default admin credentials: admin:password). Replace <hostaddr>by the IP address or the FQDN of the installation machine

Migrate to a New Server

Starting from version 2015r1, RealOpInsight 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 on the both servers. The latter case is especially useful if you want to migrate your RealOpInsight production environment from a server to another.

Backup Configuration

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 Configuration

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.