EII Documentation
4.1
EII v: 4.1
Document Versions
1.5
1.0
EII 4.1
EII 4.0
  • What is EII?
    • Introduction to Edge Insights for Industrial
    • Overview
    • High Level Architecture
  • Getting Started
    • Minimum System Requirements
    • Install Edge Insights for Industrial
      • Step 1: Prepare the Target System
      • Step 2: Download and Copy the Edge Insights for Industrial .zip File to the Target System
      • Step 3: Extract the Edge Insights for Industrial Software
      • Step 4: Configure your Installation
      • Step 5: Install the Edge Insights for Industrial Software
        • Manually Install the Manageability Module
      • Troubleshooting
        • Restart Mode
        • Docker Image Pull Issue
      • Introduction to the edgesoftware CLI
        • Get Started with the edgesoftware CLI
        • Install Package Modules
        • Update the Package Modules
        • Export the Package for Installation
        • Uninstall the Packages
        • Summary
  • Advanced Guide
    • Install Edge Insights for Industrial from source code
      • Manual Installation
        • Task 1: Install Prerequisites
        • Task 2: Generate the Deployment and the Configuration Files
        • Task 3: Build and Run the Edge Insights for Industrial Video and Time Series Use Cases
    • List of EII Services
    • Adding New Services to EII Stack
    • Steps to Independently Build and Deploy Data Store Microservice
      • Steps to Independently Build the Data Store Microservice
      • Steps to Independently Deploy Data Store Microservice
      • Deploy Data Store Service without Config Manager Agent Dependency
      • Deploy Data Store Service with Config Manager Agent Dependency
      • Data Store Configuration
        • JSON Datatype (InfluxDB/TDEngineDB)
        • Blob Datatype (MinIO Object Storage)
      • EII Msgbus Interface
        • EII Msgbus Request-Response Interface
      • DB Server Supported Version
    • Edge Video Analytics Microservice for Edge insights for Industrial (EII) Overview
      • Prerequisites
      • Run the Containers
      • Configuration
        • Config
        • Interfaces
      • Steps to Independently Build and Deploy EdgeVideoAnalyticsMicroservice Service
        • Steps to Independently Build EdgeVideoAnalyticsMicroservice Service
        • Steps to Independently Deploy EdgeVideoAnalyticsMicroservice Service
      • Camera Configurations
        • GenICam GigE or USB3 Cameras
        • RTSP Cameras
        • USB v4l2 Cameras
    • EII UDFLoader Overview
      • Dependency Installation
      • Compilation
      • Installation
      • Running Unit Tests
    • EII Sample UDFs
    • User Defined Function (UDF)
    • Multimodal Data Visualization Microservice Overview
      • Prerequisites
      • Run the Containers
        • Interfaces Section
        • Grafana Overview
        • Run Grafana for a Video Use Case
    • Multimodal Data Visualization Streaming
      • Steps to Independently Build and Deploy “Multimodal Data Visualization Streaming” Service
        • Steps to Independently Build “Multimodal Data Visualization Streaming” Service
        • Steps to Independently Deploy “Multimodal Data Visualization Streaming” Service
        • Run Multimodal Data Visualization Streaming Service with EdgeVideoAnalyticsMicroservice
    • DataStore
    • Time Series Analytics
    • Telegraf Overview
      • Plugins
      • Steps to Independently Build and Deploy the Telegraf Service
      • Steps to Independently Build the Telegraf Service
        • Steps to Independently Deploy the Telegraf Service
      • Telegraf’s Default Configuration
      • Volume Mounting of Telegraf Configuration Files
      • MQTT Sample Configuration and the Testing Tool
      • Enable Message Bus Input Plugin in Telegraf
        • Plugin Configuration
      • Advanced: Multiple Plugin Sections of EII Message Bus Input Plugin
      • Using Input Plugins
      • Enable Message Bus Output Plugin in Telegraf
      • Advanced: Multiple Plugin Sections of Message Bus Output Plugin
      • Run Telegraf Input Output Plugin in IPC Mode
      • To Add Multiple Telegraf Instances (Optional)
    • Overview of the Kapacitor
      • Introduction to the Point-Data Analytics(Time Series Data)
        • Starting the Example
        • Purpose of the Telegraf
        • Purpose of the Kapacitor
        • Custom UDFs available in the UDF([WORK_DIR]/IEdgeInsights/Kapacitor/udfs) Directory
        • Kapacitor Input and Output Plugins
      • Steps to Independently Build and Deploy the Kapacitor Service
        • Steps to Independently Build the Kapacitor Service
        • Steps to Independently Deploy the Kapacitor Service
      • Troubleshooting
      • Time Series Python UDFs Development
    • DataStore
    • Edge-to-Cloud Bridge for Microsoft Azure Overview
    • Prerequisites and Setup
      • Azure Cloud Setup
        • Setting up AzureML
        • Important
      • Development System Setup
    • OpcuaExport
      • Steps to Independently Build and Deploy the OpcuaExport Service
        • Steps to Independently Build the OpcuaExport Service
        • Steps to Independently Deploy OpcuaExport Service
      • Configuration
      • Service Bring Up
      • OPCUA Client Apps
    • RestDataExport Service
      • Steps to Independently Build and Deploy RestDataExport Service
        • Steps to Independently Build RestDataExport Service
        • Steps to Independently Deploy RestDataExport Service
      • Configuration
      • HTTP GET API of RDE
        • Get the Classifier Results Metadata
        • Get Images Using the Image Handle
        • Prerequisites to Run RestDataExport to POST on HTTP Servers
      • Launch RestDataExport Service
      • Configure Environment Proxy Settings
      • API Documentation
    • Time Series Benchmarking Tool
    • Video Benchmarking Tool
      • Run Video Benchmarking Tool with EdgeVideoAnalyticsMicroservice
        • Pre-requisites:
        • Steps for running a benchmarking test case:
    • DiscoverHistory Tool
      • Build and Run the DiscoverHistory Tool
        • Prerequisites
        • Run the DiscoverHistory Tool in the PROD mode
        • Run the DiscoverHistory Tool in the DEV Mode
        • Run the DiscoverHistory Tool in the zmq_ipc Mode
      • Sample Select Queries
      • Multi-instance Feature Support for the Builder Script with the DiscoverHistory Tool
    • EmbPublisher
      • How to Integrate this Tool with Video or Time Series Use Case
      • Configuration of the Tool
      • Running the EmbPublisher in IPC Mode
    • EmbSubscriber
      • Prerequisites
      • Run the EmbSubscriber
      • Run the EmbSubscriber in IPC mode
    • HttpTestServer
      • Prerequisites for Running the HttpTestServer
      • Starting HttpTestServer
    • MQTT Publisher
      • Usage
    • NodeRedHttpClientApp
      • Configure NodeRed
      • Getting EII UDF Classifier result Data to Node-RED Environment Using Node-RED HTTPClient
      • Sample Workflow
    • EII TimeSeriesProfiler
      • Prerequisites
      • EII TimeSeriesProfiler Mode
      • EII TimeSeriesProfiler Configuration
      • Running TimeSeriesProfiler
    • EII Video Profiler
      • EII Video Profiler Prerequisites
      • EII Video Profiler Modes
      • EII Video Profiler Configuration
      • Run Video Profiler
      • Run VideoProfiler in Helm Use Case
      • Benchmarking with Multi-instance Config
    • Run the Samples Apps
    • Web Deployment Tool
    • Ansible based EII Prequisites setup, provisioning, build and deployment
    • Installing Ansible on Ubuntu {Control node}
    • Prerequisite Steps Required for all the Control/Worker Nodes
      • Generate SSH KEY for all Nodes
    • Adding SSH Authorized Key from Control Node to all the Nodes
      • Configure Sudoers file to Accept NO PASSWORD for sudo operation
    • Updating the Leader Information for Using Remote Hosts
    • Updating the EII Source Folder, Usecase and Proxy Settings in Group Variables
    • Remote Node Deployment
    • Execute Ansible Playbook from [EII_WORKDIR]/IEdgeInsights/build/ansible {Control node} to deploy EII services in control node/remote node
      • For Single Point of Execution
      • Deploying EII Using Helm in Kubernetes (k8s) Environment
    • Installing Intel® In-Band Manageability
    • Known Issues
    • Edge Insights for Industrial Uninstaller
    • Debugging Options
    • Troubleshooting Guide
    • EII v4.1 Release Notes
      • Features
      • Known Issues
    • Changes from 3.0.0 to 4.x.y
      • Independent build and deployment of services
      • Deployment Changes
        • Deployment using docker-compose.yml on single node
        • Deployment on k8s cluster using helm
  • Developer Reference
    • Message Bus Library
      • Message Bus
        • Dependency Installation
        • Compilation
        • Generating Documentation
        • Potential Compilation Issues
        • Packaging
        • Installation
        • Running Unit Tests
        • Configuration
        • Example Usage
        • Security
        • Known issues
        • Generation of python .whl file (Optional)
      • API Documentation
    • Config Manager Library
      • ConfigMgr Overview
        • ConfigMgr Installation
        • Compilation
        • Packaging
        • Install ConfigMgr with Python bindings, Go bindings, Examples, Test suits, and Debug Build
        • Interfaces
        • Publisher Interface
        • Overriding of Type and EndPoint
      • API Documentation
  • Release Notes
    • EII 4.1.0
      • Changes
      • Known Issues
    • EII 4.0.0
      • Features
      • Known Issues
    • Open EII v3.0.1
      • Fixes
      • Known Issues
    • Open EII v3.0
      • New Features
      • Dropped Features
      • Known Issues
  • Glossary of Terms
    • General Terminology
    • Security-Related Terminology
  • Security
    • Provisioning
      • Generating Keys and Certificates
    • Start Up and Run Time
      • Accessing Secrets
    • Certificate Revocation
EII Documentation
  • 4.1 »
  • Search

© Copyright (c) 2023 Intel Corporation.

Built with Sphinx using a theme provided by Read the Docs.
EII v: 4.1
Document Versions
1.5
1.0
EII 4.1
EII 4.0