EII Documentation
2.6
EII v: 2.6
Document Versions
3.0.1
2.6

INTRODUCTION:

  • Introduction
    • Terminology
      • General Terminology
      • Security-Related Terminology
  • Overview
  • Architecture
  • Running Intel® Edge Insights for Industrial
    • Minimum System Requirements
    • Downloading and Installation from Opensource Github Repository
    • EII Prerequisites installation
      • Generating consolidated deployment and configuration files:
      • Using builder script
        • Running builder to generate the above listed consolidated files for all applicable EII services
        • Running builder to generate the above listed consolidated files for a subset of EII services:
        • Running builder to generate multi instance configs:
        • Running builder to generate benchmarking configs:
    • Provision
    • Distribution of EII container images
    • List of All EII Services
      • Common EII services
      • Video related services
      • Timeseries related services
    • Dev mode and Profiling mode
      • Dev Mode
      • Starting the EII in Dev Mode
      • Profiling Mode
    • Build and Run EII video/timeseries use cases
      • Build EII stack
      • Run EII services
      • Push required EII images to docker registry
    • EII multi node cluster provision and deployment
      • Without orchestrator
      • Ansible based EII Prequisites setup, provisioning, build & deployment
      • Installing Ansible on Ubuntu {Control node}
      • Prerequisite step needed 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 & worker node’s information for using remote hosts
      • Non-orchestrated multi node deployment (without k8s)
      • Select EII services to run on a particular node in multinode deployment
      • Execute ansible Playbook from [EII_WORKDIR]/IEdgeInsights/build/ansible {Control node} to deploy EII services in single/multi nodes
        • Deploying EII Using Helm in Kubernetes (k8s) environment
      • With k8s orchestrator
    • EII provision and deployment
      • Pre requisites
      • Update the helm charts directory
      • Provision and deploy in the kubernetes node.
        • For running helm charts and deploying kube pods with specific namespace
      • Provision and deploy mode in times switching between dev and prod mode OR changing the usecase
      • Steps to enable Accelarators
      • Steps for Enabling GiGE Camera with helm
      • Accessing Web Visualizer and EtcdUI
    • EII Uninstaller
    • Debugging
      • Debugging Through the Logs
        • working with EII Docker* Containers
        • Useful Docker* Commands
      • Debugging Video Ingestion Through gst-launch
        • GStreamer Valid Plugins / Element
        • Debugging the Video Ingestion Container
      • Enablement of X11 Forwarding for EII Visualizer Container
      • Debugging options
    • Enabling Secure boot
  • Release Notes
    • EII v2.6.3
      • Fixes
    • EII v2.6.2
      • Fixes
    • EII v2.6.1
      • Bug fixes
    • EII v2.6
      • Features
      • Known Issues
    • EII v2.5.3
      • Fixes
    • EII v2.5.2
      • Bug fixes
    • EII v2.5.1
      • Bug fix
    • EII v2.5
      • Features

CORE LIBRARIES:

  • EII Message Bus
    • EII Message Bus
      • Dependency Installation
      • Compilation
        • Generating Documentation
        • Potential Compilation Issues
      • Installation
        • Install Python Binding
        • Install Golang Binding
      • Running Unit Tests
      • Configuration
        • ZeroMQ IPC Configuration
        • ZeroMQ TCP Configuration
        • Additional ZeroMQ Configuration Properties
      • Example Usage
        • C Examples
        • Python Examples
        • Go Examples
        • Running Go Examples without Installing
        • Brokered Publish/Subscribe
      • Security
        • Using Only CurveZMQ Encryption
        • Using ZAP Authentication
        • Disabling Security
      • Known issues
    • API Documentation
  • EII Configuration Management
    • etcd
    • ConfigMgr
    • ETCD UI Service
    • Tool to Generate Configuration Management UI Service
      • Adding new EII service so it gets picked up by Builder
    • ConfigMgr
      • Installation
      • Install ConfigMgr with Python bindings, Go bindings, Examples, Test suits and Debug Build.
    • Interfaces
      • Overriding of Type and EndPoint:
      • Broker Usecase
      • zmq_tcp Protocol usecase
        • ZmqBroker:
        • Subscriber
        • Publisher
      • zmq_ipc Protocol usecase
        • ZmqBroker:
        • Subscriber
        • Publisher
        • Note “Endpoint” can be given in different ways:
      • Running Examples
        • CPP Examples
        • Python Examples
        • Go Examples
      • Running Unit Tests
    • API Documentation

VIDEO ANALYTICS PIPELINE:

  • Working with Video Data
    • VideoIngestion Module
      • Configuration
        • Ingestor config
        • Video Ingestion Contents
    • VideoAnalytics Module
      • Configuration
        • Updating Security Context Of VideoAnalytics Helm Charts for enabling Accelerators in k8s environment
      • Using video accelerators in ingestion/analytics containers
        • To run on USB devices
        • To run on MYRIAD devices
        • To run on HDDL devices
        • To run on Intel(R) Processor Graphics (GPU/iGPU)
    • User Defined Function (UDF)
    • EII UDFLoader
      • Dependency Installation
      • Compilation
      • Installation
      • Running Unit Tests
      • Introduction
      • UDF Configuration
      • UDF Writing Guide
      • Sample UDFs
        • Native UDFs
      • Construction of Metadata in UDF
      • Chaining of UDFs
        • Combination of UDFs with ingestors
      • Custom Udfs
    • Native Visualizer Module
      • Steps to build and run visualizer
      • Using Labels
      • Metadata Structure
    • Web Visualizer Module
      • Steps to build and run web visualizer
      • Using Labels
        • Metadata Structure
    • ImageStore Module
      • Configuration
        • Detailed description on each of the keys used
      • Configuration

TIME-SERIES ANALYTICS PIPELINE:

  • Working with Timeseries Data
    • Telegraf
      • Purpose of Telegraf
      • Optional: Adding multiple telegraf instances
      • Enabling EII message bus input plugin in Telegraf
      • Enabling EII message bus Output plugin in Telegraf
      • Advanced: Multiple plugin sections of EII message bus input plugin
        • Using input plugin
      • Advanced: Multiple plugin sections of EII message bus output plugin
    • Kapacitor
      • Starting the example
      • Purpose of Kapacitor
      • Purpose of plugins
      • Using input plugin
      • Using output plugin
      • User-defined Functions
      • Custom UDFs available in the udfs directory
      • Steps to configure the UDFs in kapacitor.
      • Interfaces Exposed for UDFs
      • Steps to run the samples
      • Steps to verify the results in single task with multiple UDFs
      • Steps to verify the results in multiple tasks with single UDF
      • Working with Kapacitor*
      • Configuration
      • Procedure to run Grafana
      • Steps to execute query

EXPORT SERVICES:

  • Azure Bridge
    • Pre-Requisites / Setup
      • Azure Cloud Setup
        • Setting up AzureML
      • Development System Setup
    • Build and Push EII Containers
    • Single-Node Azure IoT Edge Deployment
      • Step 1 - Provisioning
        • Expected Result
      • Step 2 - Configuring EII
        • Expected Result
      • Step 3 - Configuring Azure IoT Deployment Manifest
        • Expected Result
      • Step 4 - Deployment
        • Expected Results
      • Helpful Debugging Commands
      • Final Notes
    • Configuration
      • Azure Bridge
      • Sample EII ONNX UDF
      • Simple Subscriber
      • EII ETCD Pre-Load
      • Azure Blob Storage
      • Azure Deployment Manifest
    • Azure IoT Edge Simulator
    • Supported EII Services
    • Additional Resources
  • OpcuaExport Application
    • OpcuaExport
      • Configuration
      • Service bring up
      • OPCUA client apps
        • Note:
  • RestDataExport
    • RestExport POST Request Pipeline
    • RestExport Get Request Pipeline
    • RestExport APIs
    • RestExport POST Request API
    • RestExport GET Request API
    • Configuration
      • Pre-requisites
    • Service bring up
    • FAQs
      • For setting environment proxy settings

ADDITIONAL INFO:

  • EII Tools
    • Time Series Benchmarking Tool
    • Video Benchmarking Tool
    • 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/timeseries use case.
      • Configuration of the tool.
      • Running EmbPublisher in IPC mode
    • EmbSubscriber
      • EII pre-requisites
      • Running EmbSubscriber
      • Running EmbSubscriber in IPC mode
    • EII GigEConfig tool
      • Generating PFS(Pylon Feature Stream) File
      • Running GigEConfig Tool
        • Usage of GigEConfig tool:
        • Execution of GigEConfig
    • HttpTestServer
      • Pre-requisites for running the HttpTestServer
      • Starting HttpTestServer
    • Jupyter Notebook usage to develop python UDFs
      • Jupyter Notebook pre-requisites
      • Running Jupyter Notebook
        • Creating UDF in Jupyter Notebook
    • MQTT publisher
      • Usage
    • Software Trigger Utility for VideoIngestion Module
      • Software Trigger Utilily pre-requisites
      • Configuration file:
      • Running Software Trigger Utility
    • EII TimeSeriesProfiler
      • EII pre-requisites
      • EII TimeSeriesProfiler modes
      • EII TimeSeriesProfiler configurations
      • Running TimeSeriesProfiler
    • EII Video Profiler
      • EII Video Profiler pre-requisites
      • EII Video Profiler modes
      • EII Video Profiler configurations
      • Running Video Profiler
      • Optimizing EII Video pipeline by analysing Video Profiler results
      • Benchmarking with multi instance config
  • EII Samples
    • Steps to run EII samples apps
    • Sample CPP APP for EII platform
      • ‘Short Description of App containers’
      • The sample Golang application demonstrates the usage of EII core libraries like EIIMessageBus and ConfigManager
      • Short Description of App containers
      • The high level logical flow of Sample App is as below:
      • Sample Python APP for EII platform
      • Short Description of App containers
  • Security
    • Provisioning
      • Generating Keys and Certificates
    • Start Up and Run Time
      • Accessing Secrets
    • Certificate Revocation
EII Documentation
  • 2.6 »
  • Search

© Copyright (c) 2021 Intel Corporation.

Built with Sphinx using a theme provided by Read the Docs.
EII v: 2.6
Document Versions
3.0.1
2.6