Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This  document explains the most essential installer features.

Table of Contents

Opmantek Applications Download Formats

In the past our applications were provided in the form of a compressed tar file, which required some manual steps for unpacking and installer invocation.
As of February 2016 we've switched to a self-extracting download format which make this aspect much more user-friendly.

When you download an Opmantek Application, the file will be called <product name>-<version>.run and your browser will likely prompt you regarding what to do with this '.run' file; you should tell it to Save the file. If you are installing the application onto a different system than the one where you downloaded the file, you'll have to use scp or some other file transfer method of your choice to transfer the .run file to the target system.

Starting the Installer

Starting the new self-extracting installer is trivial: you simply tell your shell to run it.

...

Please note that the installer needs to run with root privileges, and will terminate with an error message if this requirement is not met.

Available Options

  • You can see an overview of the available options related  to the self-extracting aspect when you run the file with --help.
    • --keep ensures the unpacked data left behind (in the opProduct-version directory) after the interactive installer component has finished.
    • --noexec causes no interactive installer component to be run.
      (The combination of --noexec and --keep provides the equivalent of unpacking the tar files provided with earlier releases.)
  • An options for the interactive installer component must follow after a "--" delimiting argument.
    • If you want to perform a simulation run of the installation, use the -n option - the installer will only print what it would do, what files it would copy and so on, but will not perform any of these steps.
    • By default the installer is interactive and will prompt you for decisions and confirmations; If you want to run it in automatic batch mode, use the -y option. In this case all dialogs and prompts are automatically answered 'y'.
    • If you wanted to install the product into a non-standard directory, you can pass the argument -t <targetdir> to the installer component.

Logs and Backups

The installer saves a log of all actions taken, files copied etc. in the installation directory as install.log, ie. normally it'll be in /usr/local/omk/install.log. Subsequent upgrades or installations of other Opmantek products will add to that logfile, so you may very well want to remove or clear the install.log file before upgrading or adding extra software.

...

  • all the directories that the installer will later copy files to,
  • the conf directory,
  • the old software manifest,
  • and the old install.log.

Software Dependencies

Wherever possible the installer will help you with the installation of any missing software dependencies, using yum or apt-get depending on your operating system platform.

...

In other cases where the dependency is a "soft" one or where automatic installation isn't an option you will be shown a warning dialog about the missing dependency and the installer will wait until you confirm before continuing.

Product Coexistence, Migration and  Upgrades

Before installing any Opmantek software components, a thorough check of the existing state of your system will be made to ensure that the new product does integrate correctly with other already existing Opmantek products. This check relies on the software manifests stored in the installation directory (default /usr/local/omk) and the product tarball, and thus won't be fully precise if no manifests exist.

...

For product upgrades the installer will perform the same check and upgrade only the files and modules that are required, taking great care to not damage the function of any other existing Opmantek products. In that case the installer will also recommend a shut down of any Opmantek daemons before the installation commences, so that all files can be copied safely and without negatively affecting running daemons.

Integration and Initial Configuration

After all necessary files have been installed in their appropriate locations the installer will take care of integrating your product with the operating system, web servers and so on.

...

Code Block
++++++++++++++++++++++++++++++++++++++++++++++++++++++
opEvents is Ready for Configuration
++++++++++++++++++++++++++++++++++++++++++++++++++++++

This initial installation of opEvents is now complete.

However, to configure and fine-tune the application suitably for
your environment you will need to make certain configuration adjustments.

We highly recommend that you visit the documentation site for opEvents at

https://community.opmantek.com/display/opEvents/Home

The next step is to determine what configuration changes
will be required for your environment.

If you have started the Opmantek and the opEvents daemons,
then your new opEvents dashboard should now be accessible at
http://<HOSTNAME_OR_IP>/omk/opEvents/

If your browser is running on the same machine as opEvents was 
installed onto, this would be http://localhost/omk/opEvents/

++++++++++++++++++++++++++++++++++++++++++++++++++++++
installation complete.
++++++++++++++++++++++++++++++++++++++++++++++++++++++

FAQ

  • What's this warning about "incorrect checksum detected"?
    This can happen very infrequently,  if you are installing an older Opmantek application on top of newer ones, or if you've made extensive changes to your system's Opmantek files.
    We strive hard to line up our releases properly so that everything meshes cleanly, but every now and then there are minor changes to files that older installer versions aren't quite aware of.

    In general this warning dialog is safe to answer with 'yes' and the installer will leave your system in a consistent working state (by replacing the unrecognizable/mismatching file with a known good version from the shipped product).

...