On-Premise Installation Guide

Overview

This article is designed to assist in the preparation and installation of OverOps' on-premise Spotlight server. This is different than the standard agent install. The on-premise Spotlight server allows companies to gain the same functionality seen at the SaaS version inside their own environment.

 

Hardware requirements

CPU: modern 8 core

RAM: 16GB

Storage: 200GB

 

Software requirements

 Modern Linux (minimum kernel: 3.10).

  1. Docker binaries:
    • Docker engine: https://docs.docker.com/engine/installation/
    • Docker compose: https://docs.docker.com/compose/install/
      • Make sure to give execute permissions to docker-compose file.
  2. Root user access.
  3. Two HTTP ports open (default: 8080, 9090).
  4. An extra TCP port open for a remote collector (default: 6060).

     Note: Please be advised, make sure to choose an optimal docker configuration for your linux and for your
              environment workloads. Production requires a more robust docker configuration.
              See recommendations from the docker blog here.

Storage requirements

  1. Docker working folder is /var/lib/docker - it should contain at least 10GB of free disk space.
  2. OverOps server is installed under /opt/takipi-server and should have at least 200GB of free disk space.

 

Installation

Server installation

Make sure you are using root / sudo for the following commands:

  1. Get the latest OverOps server tarball: takipi-server-latest.tar.gz.
  2. Unpack to /opt
    tar zxvf <path-to-downloads>/takipi-server-latest.tar.gz
  3. Run Setup
    /opt/takipi-server/bin/takipi-server.sh start -u <HOSTNAME>
  4. Activate OverOps - send the license ID to OverOps and receive your license key.
    • Browse to http://<HOSTNAME>:8080/activate
    • Follow the onscreen information and enter the license key as provided by OverOps.
  5. Sign up for OverOps to generate an agent installation key.
    • Browse to http://<HOSTNAME>:8080/?signup
  6. Create a specialized one-liner agent installation script by replacing the following <HOSTNAME> and <AGENT_INSTALLATION_KEY>.
    The one-liner can be found in the webapp under "Add Servers"
    wget -O - -o /dev/null "http://<HOSTNAME>:8080/app/download?t=inst" | bash /dev/stdin -i --sk=<AGENT_INSTALLATION_KEY> --s3_url http://<HOSTNAME>:8080/service/png --installer_url "http://<HOSTNAME>:8080/app/download?t=tgz" --base_url http://<HOSTNAME>:8080

Server upgrade 

  1. Get the latest OverOps server tarball: takipi-server-latest.tar.gz.
  2. Run upgrade (as root): /opt/takipi-server/bin/takipi-upgrade.sh <path-to-new-tar-ball>

 

Client installation
Remote collector installation

  1. The remote collector listens on a TCP port provided with the parameter --listen_on_port=<PORT>.
  2. Append the --listen_on_port=<PORT> parameter to the one-liner to install the client as a remote collector. You will need to make sure the hostname is resolvable from where you plan on running the OverOps agents (your application server, the JVMs).
    wget -O - -o /dev/null "http://<HOSTNAME>:8080/app/download?t=inst" | bash /dev/stdin -i --sk=<AGENT_INSTALLATION_KEY> --s3_url http://<HOSTNAME>:8080/service/png --installer_url "http://<HOSTNAME>:8080/app/download?t=tgz" --base_url http://<HOSTNAME>:8080 --listen_on_port=6060
  3. To install the agent and pair it with a remote collector, add the following parameters to the one-liner from above:
    --daemon_host=<REMOTE_COLLECTOR_HOSTNAME> --daemon_port=<REMOTE_COLLECTOR_PORT>

    wget -O - -o /dev/null "http://<SERVER_HOSTNAME>:8080/app/download?t=inst" | bash /dev/stdin -i --sk=<AGENT_INSTALLATION_KEY> --s3_url http://<SERVER_HOSTNAME>:8080/service/png --installer_url "http://<SERVER_HOSTNAME>:8080/app/download?t=tgz" --base_url http://<SERVER_HOSTNAME>:8080--daemon_host=<REMOTE_COLLECTOR_HOSTNAME> --daemon_port=<REMOTE_COLLECTOR_PORT>

  4. Append OverOps agent argument: -agentlib:TakipiAgent to your JVMs:
  5. For more information about OverOps remote collector, click here.

 


Quick installation

  1. As root: install OverOps agent on clients with the complete one-liner.
  2. Append OverOps agent argument: -agentlib:TakipiAgent to the JVMs:
    • Append to the JVM arguments list.
      • Usually defined in a JAVA_OPTS or JAVA_OPTIONS environment variable.
Have more questions? Submit a request