Installing Envision 1.2.1

Learn how to install the Envision 1.2.1 analytics and monitoring solution.

Note: Envision 1.2.1 runs on Akana Platform 8.4.x. If you're using Akana Platform 8.2.x, you'll need to upgrade to 8.4x or use Envision 1.2. see Installing Envision 1.2.

System Requirements for Akana Envision 1.2.1 Envision Reference

Supported Platforms: 8.4 (with PM Analytics Plugin 8.4)

Table of Contents

Installation Procedure: Completely new installation
Installation Procedure: Adding Envision to an existing installation
Installation Tasks/Reference:

Installation Procedure: Completely new installation

Introduction

Installation of the Envision 1.2.1 analytics and monitoring solution requires:

  • Installation of version 8.4 of the Akana Platform.
  • Installation of the corresponding version (same release number) of the PM Analytics Plugin.
  • Installation and setup of a MongoDB database. For information on supported versions, see Supported MongoDB versions.
  • Setting up at least one Policy Manager container.
  • Installation and configuration of the Envision feature on the Policy Manager container.

Note: If you're installing Envision in a separate container from Policy Manager, see Installing Envision in its own container.

Step 1: Download and Install MongoDB

  1. Go to http://www.mongodb.org/downloads and download the MongoDB Version 3.2 file for your platform. Windows 64-bit (MSI), Linux 64-bit (TGZ), and Solaris 64-bit (TGZ) are supported. If you are on a Mac, you can install Mongo with homebrew using brew install mongo.
  2. Install MongoDB on your platform.

Note: these instructions provide a basic MongoDB installation approach. For information on installation instructions and shutdown procedures for your specific deployment, refer to the MongoDB documentation at this URL: https://docs.mongodb.org/v3.2/tutorial/manage-mongodb-processes.

back to top

Step 2: Create MongoDB Data Folder

  1. Create a MongoDB data folder. The default is /data/db. If you prefer to use a different location, use --dbpath.

back to top

Step 3: Start MongoDB

  1. Navigate to the MongoDB installation directory: for example, /MongoDB/3.2/bin.
  2. Enter mongod.
  3. If MongoDB successfully starts, your command window displays waiting for connections followed by the port number.

Note (Linux only): Once you've started MongoDB, you might need to run the fork command to keep it running in the background while you complete the other installation steps. logpath sets the path for the log. For example: mongod -fork -logpath /opt/mongodb/mongod.log.

back to top

Step 4: Install Akana Platform

The Envision product must be installed to the Akana Platform. For detailed instructions, refer to the installation documentation:

If the Akana Platform is already installed, skip to the next step.

back to top

Step 5: Run Configurator to create a Policy Manager container

Note: If you're installing Envision in a separate container from Policy Manager, see Installing Envision in its own container.

The Configurator steps you through creating a container, specifying basic values about the container.

Create a Policy Manager container. For detailed instructions, refer to Run Configurator to create the first container and Install Policy Manager/Community Manager features on the container. You don't need to install Community Manager to run Envision, only the Policy Manager features. Choose features applicable for your installation, but at a minimum the Policy Manager features.

back to top

Step 6: Download ZIP files for Envision and the PM Analytics Plug-In

Envision and the PM Analytics Plug-In must be installed to the Akana Platform. Download the ZIP files from the Akana Customer Support site.

  1. Log in to the Akana support site.
  2. Go to Downloads > Envision > 1.2.1.
  3. Download the Envision ZIP file:

    akana-envision-1.2.2502.zip

  4. Go to Downloads > Envision > PM Analytics Plugin.
  5. Go to the folder for the version corresponding to your platform version, and download the ZIP file:
    • PM-AnalyticsPlugin8.4 > akana-pm-envision-8.4.235.zip

back to top

Step 7: Install Envision into the Policy Manager container

For detailed instructions for installing Envision into the Policy Manager container, follow Existing Policy Manager installation: Steps for installing Envision.

back to top

Step 8: Install and Configure Sample Data Sets

  1. On the Available Features screen, from the Filter menu at the top left, select Plug-ins.
  2. Select the Akana Sample Data Sets for Demo Charts plug-in, and click Install Feature.
  3. After the installation is complete, click Configure and continue.
  4. On the Configure Sample Data Sets screen, select the checkbox for each data set you want to install. Click Finish, and then click OK to restart the container.
  5. When the restart is complete, click Close.

Note: After the installation is compete, you can manage (install / uninstall) data sets via the Configuration tab by selecting Configure Sample Data Sets.

back to top

Step 9: Launch Envision Console

  1. Enter the following URL to launch the Envision Console:

    http://{hostname}:{port}/analytics/login

  2. Log into the Envision Console using the Username/Password you defined for your Envision container, and then click the Dashboards tab.

    Note: Sign in using the Local Domain, not the Admin Console domain.

    Envision

  3. If you do not see the data sets and/or have problems logging into the Envision Console, restart the Envision container (See Starting and Stopping a Container Instance and refer to Step 3: Start MongoDB for instructions on how to start MongoDB.

back to top

Installation Procedure: Adding Envision to an existing installation

Prerequisites

You'll need the following:

  • Akana Envision and PM Analytics Plug-In ZIP files. For example:
    • akana-pm-envision-8.4.235.zip
    • akana-envision-1.2.2502.zip
  • MongoDB. For example, MongoDB Community 3.2. For information on supported versions, see Supported MongoDB versions.

Existing Policy Manager installation: Steps for installing Envision

The steps below assume an existing installation of Akana API Platform 8.4x. The installation should already have the Akana MongoDB Support feature enabled for all Akana containers.

These steps are for manual installation of the Envision feature. If you want to use the automation script to enable this feature, please consult with your Akana Professional Services representative.

These steps cover installation of applicable components into:

  • The first Policy Manager container
  • Additional Policy Manager containers
  • Network Director containers
To install Envision in an existing Policy Manager installation
  1. Unzip akana-pm-envision-8.4.235.zip and akana-envision-1.2.2502.zip to the Akana installation folder for all Akana instances. For example: /opt/akana/ap84.
  2. Choose one Policy Manager container for installation of Envision. It must be installed directly on one of the PM containers.
  3. Restart the container.

    After restart, you'll see the following Envision features or plug-ins in the Akana Administration Console for the container:

    • Akana Envision Metrics Collector (plug-in)
    • Akana Envision (feature)
    • Akana Envision Policy Manager Service Extensions (plug-in)
    • Akana Envision Policy Manager Console Extensions (plug-in)
    • Akana Policy Manager Analytics Security Provider (plug-in)
    • Akana Sample Data Sets for Demo Charts (plug-in)
  4. Install the following feature:
    • Akana Envision
  5. Install the following plug-ins:
    • Akana Policy Manager Analytics Security Provider
    • Akana Envision Policy Manager Service Extensions
    • Akana Envision Policy Manager Console Extensions (choosing this option also installs the Akana Envision Metrics Collector plug-in)
  6. Restart the container.
  7. For any additional Policy Manager containers after the first: Conditional: if the PM container is installed on a different machine, repeat Step 1. Then, install only the following plug-ins:
    • Akana Envision Policy Manager Service Extensions
    • Akana Envision Policy Manager Console Extensions (choosing this option also installs the Akana Envision Metrics Collector plug-in)
  8. For all Network Director containers: Conditional: if the ND container is installed on a different machine, repeat Step 1. Then, install only the following plug-in:
    • Akana Envision Metrics Collector
  9. Log in to the Envision portal running on http://{PM/Envision URL}/analytics.

If you're running Envision in its own container, see Installing Envision in its own container for an installation feature list.

back to top

Installation Tasks/Reference:

Database and Container Shutdown Procedure

When shutting down your Envision system, it's important to shut down the Envision container, and MongoDB database in the following sequence to avoid data loss and/or the requirement of performing data repair.

  1. First, shut down the container. Refer to Starting and Stopping a Container Instance for shutdown options.
  2. Then, shut down the MongoDB container. For information on installation instructions and shutdown procedures for your specific deployment, refer to the MongoDB documentation at this URL: https://docs.mongodb.org/v3.2/tutorial/manage-mongodb-processes.

back to top

Configuration Action: Configure Envision Time Zone

Data aggregation for Envision requires that you set up a Policy Manager rollup time zone to match the Envision time zone setting. When Envision retrieves data for a chart, it selects only records that match exactly the time zone set in this configuration action. If the Envision time zone isn't set, or is set incorrectly, charts might include data for an incorrect time period, or might not show any data at all, because of time zone differences.

Configuring the global time zone for rollups

Set the Default Time Zone, Rollup Time Zone, and Time Zone Alias, as needed.

back to top

Supported MongoDB versions

For information on the MongoDB versions supported with Envision, refer to the System Requirements doc for Envision.

back to top

Installing Envision in its own container

You can install Envision on a separate container from the Akana API Platform, so that it's only reading data from the MongoDB database, not running on the same container where API traffic is processed and transactions are written to the database.

By running Envision in a separate container, you can avoid having to expose the Envision user interface and authentication on your main runtime container.

In this scenario, you still need to have Policy Manager installed on the container. This is needed so that you can use the local domain for authentication of the Envision user.

If the instance is on a separate machine, you'll need to get the ZIP files (see To install Envision in an existing Policy Manager installation, Step 1, above).

Then, if you're installing Envision into a standalone container, you'll need to make sure you install the following features in the different installation containers:

These are the minimum required features and/or plug-ins for each type of container, so that a standalone container running Envision will work correctly.

Standalone Envision container

Features:

  • Akana Policy Manager Console
  • Akana Policy Manager Services
  • Akana Envision

Plug-ins:

  • Akana Policy Manager Analytics Security Provider
Primary Policy Manager container

Plug-ins:

  • Akana Envision Policy Manager Service Extensions
  • Akana Envision Policy Manager Console Extensions (choosing this option also installs the Akana Envision Metrics Collector plug-in)
Network Director containers

Plug-ins:

  • Akana Envision Metrics Collector

back to top