Step 1: Prepare the Target System

Make sure your target system has a fresh installation of Ubuntu* Linux that corresponds to the version of Edge Insights for Industrial that you downloaded. If you need help installing Ubuntu* Linux, follow these steps:

1. Download Ubuntu* Linux* Desktop ISO file to your developer workstation.

2. Use an imaging application to create a bootable flash drive.

3. Power off your target system, insert the USB drive, and power on the system.

   If the target system doesn’t boot from the USB drive, change the boot priority in the system BIOS.

4. Follow the prompts to install Ubuntu* Linux with the default configurations. For detailed instructions, see the Ubuntu guide.

5. Power down your target system and remove the USB drive.

6. Power up the target system. You will see Ubuntu* Linux is successfully installed.

7. Log on as the root user:

   su root

Step 2: Download and Copy the Edge Insights for Industrial .zip File to the Target System

In this step you download the package and copy Edge Insights for Industrial to your target system.

1. Download the Edge Insights for Industrial package.

2. Copy edge_insights_industrial.zip from the developer workstation to the Home directory on your target system. You can use a USB flash drive to copy the file. The icon looks like this:

   

Step 3: Extract the Edge Insights for Industrial Software

In this step you extract edge_insights_industrial.zip. You need to be on the target system to complete these steps.

1. Ensure that you have a working internet connection.

2. Open a new terminal.

3. Extract the package:

   unzip edge_insights_industrial.zip

   NOTE:

   If you download the file more than once, each download beyond the first is appended by a number.

   

4. (Optional) Use the link in the readme file to open this Get Started Guide on the target system for an easy way to copy and paste commands.

Step 4: Configure your Installation

This is a mandatory step. You can use the config_install.yml file to configure the installation behavior of the components in your target system.

You can modify the config_install.yml per your requirements using the following information:

Edge Insights for Industrial

• dev_mode: This key sets your installation mode. Set the key value as follows:

  • true: This value enables the Production mode which is the default mode. In this mode, security and encryption are enabled. This mode is commonly used for deployment.

  • false: This value enables the Development mode. In this mode, security and encryption are disabled. This mode is commonly used during evaluation and development as it eases the integration and testing of User Defined Applications.

• remove_previous_eii: Set this key value as ‘true’ if you want to remove the already existing containers of Edge Insights for Industrial previous installation.

• default_use_case: If you have downloaded the full Video Analytics + Time Series Edge Insights for Industrial package, you can set the type of use case you want to install using this key value as below:

  • video-timeseries: Includes modules for video and timeseries, i.e., the full use-case.

  • video: Includes only video modules and adds databases for storing images and metadata of analytics results.

  • time-series: Includes modules for time-series data ingestion, storage and analytics.

• etcdroot_password: Updates the etcdroot password credential.

• influxdb_username: If the downloaded edgesoftware_configuration.xml file contains the InfluxDBConnector module. Set the username credential value. The following special characters are not allowed for the influxdb_username~:'+[/@^{%(-"*|,&<`}._=}!>;?#$)\

• influxdb_password: If the downloaded edgesoftware_configuration xml file contains the InfluxDBConnector module. Set the password credential value. The following special characters are not allowed for the influxdb__password~:'+[/@^{%(-"*|,&<`}._=}!>;?#$)\

• webvisualizer_username: If the downloaded edgesoftware_configuration.xml file contains WebVisualizer module. Set the username credential value.

• webvisualizer_password: If the downloaded edgesoftware_configuration.xml file contains WebVisualizer module. Set the password credential value.

• minio_access_key: If the downloaded edgesoftware_configuration.xml file contains ImageStore module. Set the access key credential value. The minio_access_key length must be a minimum of 8 characters.

• minio_secret_key: If the downloaded edgesoftware_configuration.xml file contains ImageStore module. Set the secret key credential value. The minio_secret_key length must be a minimum of 8 characters.

Step 5: Install the Edge Insights for Industrial Software

You will now run a script that will download components and install Edge Insights for Industrial on your target system.

The software installation can take 1 to 3 hours depending on the package you chose. The completion time depends on your target system and Internet connection.

1. Run these commands:

   cd edge_insights_industrial/
   chmod 775 edgesoftware
   ./edgesoftware install

   NOTE:

   If you encounter any Docker* pull-related issues during the installation process, refer to the :doc: Troubleshooting </install-edge-insights-for-industrial> section at the end of this document.

2. Type the product key at the prompt:

Based on components selected and system configuration, you might be prompted for additional actions if you have not configured the config_install.yml file correctly.

When the installation is complete, you see the message Installation of package complete and the installation status for each module.

To confirm your installation was successful and for a quick look at how it works, use the Introduction to the Command Line Interface.

Steps for Manual Installation of Manageability Module

• Go to edge_insights_industrial/Edge_Insights_for_Industrial_<version>/manageability/

  where <version> indicates the downloaded version of Edge Insights for Industrial.

• Refer to the steps in README.md for manual installation of manageability component.

Troubleshooting

• Make sure you have an active internet connection during the full installation. If you lose Internet connectivity at any time, the installation might fail.

• If the eii installer component fails to install after running the ./edgesoftware install command, check the running containers list using docker ps command and check the logs of the failing containers to find out why they are failing. Mostly services like InfluxDBConnector, Grafana, Imagestore, etc., fail if the port is already used by other process on the host m/c as EII uses docker host network. Please make sure to free up that port and re-run the ./edgesoftware install command or follow the steps below:

  • Go to edge_insights_industrial/Edge_Insights_for_Industrial_<version>/IEdgeInsights/build

    where <version> indicates the downloaded version of Edge Insights for Industrial.

  • Run sudo sg docker -c docker-compose up -d command to relaunch services.

Restart Mode

The following services may be in restart mode after successful installation. Refer to the respective README.md files to troubleshoot, where <version> indicates the downloaded version of Edge Insights for Industrial:

• Visualizer:edge_insights_industrial/Edge_Insights_for_Industrial_<version>/IEdgeInsights/Visualizer/README.md

• FactoryControlApp:edge_insights_industrial/Edge_Insights_for_Industrial_<version>/IEdgeInsights/FactoryControlApp/README.md

• RestDataExport:edge_insights_industrial/Edge_Insights_for_Industrial_<version>/IEdgeInsights/RestDataExport/README.md

Docker Image Pull Issue

This issue can be because of the latest pull rate limitations introduced by Docker hub.

• Please check this Docker site article to help determine the exact pull limit that’s applicable on the system where you are trying to pull the publicly available Docker hub images, such as Docker, Python, etc.

  NOTE:

  This limit is only applicable for the 6-hour window.

• If you see this issue with an anonymous user (pull limit of 100), i.e., without Docker login, you can create an account and try to do the build after running the command: docker login -u <username> -p <password>. The alternative is to use a paid subscription.

If you’re unable to resolve your issues, go to the Support Forum.