Get Started Guide#

  • Time to Complete: 1 hour

  • Programming Language: Python*

Get Started#

Prerequisites#

The following are the minimum system requirements to run Intel® Edge Insights System.

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

The Intel® Edge Insights System package should be installed on your system.

Run using docker compose#

Run the following command from the [work_dir]/IEdgeInsights/build directory:

   python3.10 builder.py -f usecases/<usecase>.yml
   # Launch the services
   ./run.sh -v -s

Note:

  • Any Intel® Edge Insights System service waits/restarts if the config manager data store client key and certificates are yet to be made available for the container.

  • By default, the Intel® Edge Insights System Certificates, configs and secrets (etcd certificates, pem/grpc certificates) will not be regenerated upon container restarts and if one has to force this recreation, then you have to delete the docker volume by either running docker compose down -v or docker volume rm edgeinsightssoftware_vol_cma_status_file

Summary#

In this get started guide, you learned how to run the Config Manager Agent Microservice.

Learn More#

  • Follow step-by-step examples to become familiar with the core functionality of the microservice in Tutorial.

  • Understand the components, services, architecture, and data flow in the Overview.

Troubleshooting#

If the Config Manager Agent microservice has not started or is not functioning as expected, check the logs of the microservice as follows.

Error Logs#

To see the error logs, run the following command from the host system terminal:

   docker logs -f ia_configmgr_agent

To filter the error logs, run the following command:

   docker logs -f ia_configmgr_agent|grep -i error