Get Started Guide#

  • Time to Complete: 20 minutes

  • Programming Language: Python and Javascript

Get Started#

Prerequisites#

System Requirement

Details

Processor

11th Generation Intel® Core™ processor or above with Intel® HD Graphics, or Intel® Xeon® processor

RAM

Minimum 16 GB

Hard Drive

Minimum 64 GB; 128 GB recommended.

Operating System

Ubuntu* 22.04

Docker* Platform

Version 24.0.72 and above

Installation from the installer package downloaded#

This section provides information for the following:

  1. Prepare your target system.

  2. Copy the Intel® Visualization Package.

  3. Complete the installation steps.

Step 1: Prepare the Target System#

Ensure that the target system has a fresh installation of Ubuntu* Linux. The Ubuntu* Linux version should correspond to the version of Intel® Visualization Package that you downloaded.

If you need help with installing Ubuntu* Linux, follow these steps:

  1. Download Ubuntu\* Linux\* Desktop ISO file <https://ubuntu.com/download/desktop>__ to your developer workstation.

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

  3. Turn off the target system, insert the USB flash drive, and power on the system.

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

  5. Follow the prompts to install Ubuntu* Linux with the default configurations. For detailed instructions, see the Ubuntu guide <https://ubuntu.com/tutorials/tutorial-install-ubuntu-desktop#1-overview>__.

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

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

Step 2: Download and Copy the Intel® multimodal-data-visualization-microservice.zip File to the Target System#

In this step, you download the Intel® Visualization Package and copy Intel® Visualization Package to your target system.

  1. Open page Intel® Visualization Package from browser.

  2. You will see the request access button at the top which needs to be clicked.

    Request Access

  3. You will receive email when you click on the Request Access option.

  4. Once the access request gets approved, you will receive mail having the Product key to download the package.

  5. Download the Intel® Visualization Package.

    Download Page

  6. Copy multimodal-data-visualization-microservice.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:

    Folder Structure

Step 3: Extract the Intel® Visualization Package Software#

In this step you extract the multimodal-data-visualization-microservice.zip file. You need to be on the target system to complete the following steps:

  1. Ensure that you have a working internet connection.

  2. Open a new terminal.

  3. Extract the package:

       unzip multimodal-data-visualization-microservice.zip

    NOTE:

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

    After extracting the package, you can view the following files:

    The extracted package view

Step 4: Configure your Installation#

The config_install.yml contains information about the modules to install. You can modify this file and configure the installation behavior of the components in your target system.

NOTE: - This is step is mandatory for Intel® Visualization Package installation. - Ensure that you update the visualizer_grafana_user, visualizer_grafana_password, etcd root_password, influxdb_username, influxdb_password, minio_access_key and minio_secret_key as this is required for the Intel® Visualization Package installation.

Based on your requirements, modify the config_install.yml file. For more information, refer to the following table:

Key

Value and Description

remove_previous_eii

Set this key value as true to remove any existing containers of Intel® Edge Insights System from the previous installation.

etcd_root_password

This key’s value updates the etcd root password credential. Length must be a minimum of 10 characters.

influxdb_username

Do not use the following special characters in the influxdb_username “~:’+[/@^{%(-“*|,&<`}._=}!>;?#$)”.Length must be a minimum of 5 characters.

influxdb_password

Do not use the following special characters in the influxdb_password “~:’+[/@^{%(-“*|,&<`}._=}!>;?#$)”Length must be a minimum of 10 characters.

minio_access_key

The minio_access_key length must be a minimum of 5 characters.

minio_secret_key

The minio_secret_key length must be a minimum of 10 characters.

visualizer_grafana_user

The visualizer_grafana_user length must be a minimum of 5 characters.

visualizer_grafana_password

The visualizer_grafana_password length must be a minimum of 10 characters.

Step 5: Install the Intel® Visualization Package Software#

NOTE:

  • If you are using a proxy server, then ensure that the proxy settings are configured correctly. The edgesoftware tool uses the proxy settings to download and install the modules.

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

  • If you encounter any Docker* pull-related issues during the installation process, refer to the Troubleshooting <#troubleshooting>__ section.

You will now run a script to download components and install Intel® Visualization Package on your target system. Complete the following:

  1. Run the following commands:

       cd multimodal-data-visualization-microservice
   chmod 775 edgesoftware
   ./edgesoftware install

NOTE:

  • Ensure valid parameters added in config_install.yml file prior running the command ./edgesoftware install.

  • If ./edgesoftware install command fails because of not being able to pull the container image, please retry by re-running the sudo ./edgesoftware install command. Once the installation is successful, please run command: sudo chown -R $USER:$USER multimodal-data-visualization-microservice_<version> to update the file ownership to the current user and please reboot the system once to activate the current user addition to docker group.

  1. At the command prompt, enter the Product Key.

Product key

NOTE: Ensure to enter the valid Product key that you have received in the email.

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 Installation of package complete message and the installation status for each module. Refer to the following screenshot:

Status


## Summary

In this get started guide, you learned how to install the visualizer package.

## Learn More

-  Follow step-by-step examples to become familiar with the core
 functionality of the microservice in
 [Tutorials](Tutorials.md) 
-  Understand the components, services, architecture, and data flow in
 the [Overview](Overview.md)

## Troubleshooting


Errors when running ``docker`` command:

- Ensure that Docker platform is installed, using the command ``docker info``
- Check that the Docker installation is working correctly by running ``docker run hello-world``

### Error Logs
The microservice runs as a Docker Compose service. You can view the logs of the container using Docker:

docker logs multimodal-data-visualization-streaming docker logs multimodal-data-visualization

## Known Issues
- Some network environments may prevent communication with subscribable services