.. _install-edge-insights-for-industrial: ############### Getting Started ############### .. include:: ../IEdgeInsights/minimum-system-requirements.rst Install Edge Insights for Industrial ------------------------------------ This section provides information for the following: #. Prepare your target system. #. Copy the EII package. #. Complete the installation steps. .. note:: - During the installation, you will be prompted to enter your product key. This key is in the email that you received from the Intel® Registration Center. Contact the `Support Forum `__ if you do not have this email message. - Be aware that screenshots may show a package version number that is different from the current release. For information on the current release, see the `Release Notes `_. 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 EII that you downloaded. If you need help with installing Ubuntu* Linux, follow these steps: #. Download `Ubuntu\* Linux\* Desktop ISO file `__ to your developer workstation. #. Use an imaging application to create a bootable flash drive. #. Turn off the target system, insert the USB flash drive, and power on the system. #. If the target system doesn't boot from the USB flash drive, change the boot priority in the system BIOS. #. Follow the prompts to install Ubuntu* Linux with the default configurations. For detailed instructions, see the `Ubuntu guide `__. #. Power down your target system and remove the USB drive. #. Power up the target system. You will see Ubuntu\* Linux is successfully installed. Step 2: Download and Copy the Edge Insights for Industrial .zip File to the Target System ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In this step, you download the EII package and copy EII to your target system. #. Download the `Edge Insights for Industrial package `__. #. 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: .. figure:: image/GUID-B0D1AFD9-8679-4614-A3CB-1FCBF04FA87A-low.png :scale: 100 % Step 3: Extract the Edge Insights for Industrial Software ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In this step you extract the ``edge_insights_industrial.zip`` file. You need to be on the target system to complete the following steps: #. Ensure that you have a working internet connection. #. Open a new terminal. #. Extract the package: .. code-block:: bash unzip edge_insights_industrial.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: .. figure:: image/GUID-A88FA8C0-8733-46D7-9CEA-6A9023C32493-low.png :scale: 100 % #. (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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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 EII installation. - Ensure that you update the ``etcd root_password, influxdb_username, influxdb_password, minio_access_key`` and ``minio_secret_key`` as this is required for the EII installation. 1. Based on your requirements, modify the ``config_install.yml`` file. For more information, refer to the following table: .. list-table:: :header-rows: 1 * - Key - Value and Description * - **dev_mode** - This key is used to set the installation mode. You can 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` to remove any existing containers of EII from the previous installation. * - **etcd root_password** - This key's value updates the etcdroot password credential. * - **influxdb_username** - If the downloaded edgesoftware_configuration.xml file contains the DataStore module, then you must set the username credential value. Do not use the following special characters in the influxdb_username ``"~:'+[/@^{%(-"*|,&<`}._=}!>;?#$)\"`` * - **influxdb_password** - If the downloaded ``edgesoftware_configuration.xml`` file contains the DataStore module, then you must set the password credential value. Do not use the following special characters in the influxdb_password ``"~:'+[/@^{%(-"*|,&<`}._=}!>;?#$)\"`` * - **minio_access_key** - If the downloaded edgesoftware_configuration.xml file contains the DataStore module, then you must set the value for the access key credential. Note that the minio_access_key length must be a minimum of 8 characters. * - **minio_secret_key** - If the downloaded ``edgesoftware_configuration.xml`` file contains the DataStore module, then you must set the value for the secret key credential. Note that the minio_secret_key length must be a minimum of 8 characters. 2. Based on your requirement, configure EII in any of the following mode: - Development mode (DEV mode)—this mode eases the development phase for System Integrators (SI). - Production mode (PROD mode)—this mode allows you to perform production programming tasks. - Profiling mode—this mode allows you to collect the performance statistics in EII. To configure EII, you can customize the working environment variables in the ``.env`` file. The ``.env file`` is in the ``[WORK_DIR]/$HOME/edge_insights_industrial/Edge_Insights_for_Industrial_/IEdgeInsights/build`` folder. Step 5: Install the Edge Insights for Industrial 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 Edge Insights for Industrial on your target system. Complete the following: 1. Run the following commands: .. code-block:: bash cd edge_insights_industrial/ chmod 775 edgesoftware ./edgesoftware install .. note:: - For more details about edgesoftware refer to the `Introduction to the edgesoftware CLI <#introduction-to-the-edgesoftware-cli>`__ section. - If `./edgesoftware install` command failures happens because of not being able to pull the container image, please retry by re-running the command again. - Please perform following steps for "Universal Wellpad Conrtoller" Usecase: a. Go to the ``[WORK_DIR]/edge_insights_industrial/Edge_Insights_for_Industrial_/IEdgeInsights/build`` folder and run ``sudo ./pre_requisites.sh`` on non-proxy environment machines; if the machine is in a proxy environment, run the command below: .. code-block:: bash sudo ./pre_requisites.sh --proxy=: b. For more details regarding use case selection, please refer `Universal Wellpad Conrtoller `__ section. 2. At the command prompt, enter the Product Key. .. figure:: image/GUID-5C11C087-C987-439F-804F-ED78A80774D7-low.png :scale: 100 % .. note:: See the Edge Insights for Industrial-based Reference Implementation (RI) tutorial requirements in the following table. .. list-table:: :header-rows: 1 * - S.No - RI Tutorial - Applicable Use Case - Requirement * - 1 - Defect Detection Demo - \ **Video Analytics** or **Video Analytics and Time series**\ - Download the installer package through the **Download Recommended Configuration** option by choosing one of the use cases (see Applicable Use Case column) in the `Edge Insights for Industrial package `__. .. * - 2 - Weld Porosity Detection Demo - \ **Video Analytics** or **Video Analytics and Time series**\ - Download the installer package through the **Customize Download** option by choosing one of the use cases (see Applicable Use Case column) in the `Edge Insights for Industrial package `__ and additionally selecting the **Weld Porosity Detection** RI. * - 3 - Industrial Text Line Recognition - \ **Video Analytics** or **Video Analytics and Time series**\ - Download the installer package through the **Customize Download** option by choosing one of the use cases (see Applicable Use Case column) in the `Edge Insights for Industrial package `__ and additionally selecting the **Industrial Text Line Recognition** RI. * - 4 - Industrial Surface Defect Detection - \ **Video Analytics** or **Video Analytics and Time series**\ - Download the installer package through the **Customize Download** option by choosing one of the use cases (see Applicable Use Case column) in the `Edge Insights for Industrial package `__ and additionally selecting the **Industrial Surface Defect Detection** RI. * - 5 - Textile Defect Classifier - \ **Video Analytics** or **Video Analytics and Time series**\ - Download the installer package through the **Customize Download** option by choosing one of the use cases (see Applicable Use Case column) in the `Edge Insights for Industrial package `__ and additionally selecting the **Textile Defect Classifier** RI. 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: .. figure:: image/GUID-938FA8AD-9D93-43D5-8439-7383DCC61D5D-low.png :scale: 100 % .. note:: - For Video Analytics and Time Series or Video Analytics or Time Series use cases, the demo does not start automatically. Do the following steps to see the demonstration: - Launch Grafana to see the video and time series visualization. For details, refer to `Edge Insights Visualizer Readme` from `$HOME/edge_insights_industrial/Edge_Insights_for_Industrial_/IEdgeInsights/Visualizer/README_EII.md`. To confirm your installation was successful and for a quick look at how it works, use the `Introduction to the Command Line Interface <#introduction-to-the-edgesoftware-cli>`__. Manually Install the Manageability Module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The Manageability module offers over-the-air system updates and management through a cloud-based management front end. This module requires an account with a cloud services provider. The Manageability is downloaded by default, but not auto installed. To manually install the Manageability module: #. Go to ``edge_insights_industrial/Edge_Insights_for_Industrial_/manageability/`` where indicates the downloaded version of Edge Insights for Industrial. #. Refer to steps for the manual installation of the Manageability component in README.md. .. _Troubleshooting: Troubleshooting ^^^^^^^^^^^^^^^ This section provides information about troubleshooting and resolving installation-related issues. - Ensure that 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, then do the following: #. Check the list of the running containers using the following command: .. code-block:: bash docker ps #. Check the logs of the failing containers to find the reason for the issue. .. note:: Services such as DataStore and Visualizer will fail, if the port is already used by other processes on the host machine as EII uses docker host network. Ensure to free up that port and rerun the ./edgesoftware install command or do the following: #. Go to ``edge_insights_industrial/Edge_Insights_for_Industrial_/IEdgeInsights/build`` where indicates the downloaded version of Edge Insights for Industrial. #. Run the following command to relaunch services: .. code-block:: bash sudo sg docker -c docker-compose up -d Restart Mode ~~~~~~~~~~~~ The following services may be in **restart mode** after successful installation. Refer to the respective README.md files to troubleshoot, where ```` indicates the downloaded version of Edge Insights for Industrial: - **FactoryControlApp:** ``edge_insights_industrial/Edge_Insights_for_Industrial_/IEdgeInsights/FactoryControlApp/README.md`` Docker Image Pull Issue ~~~~~~~~~~~~~~~~~~~~~~~ This issue cccurs due to the latest pull rate limitations introduced by Docker Hub. - 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 this issue occurs for an anonymous user (without Docker login and with pull limit of 100), you can `create an account `__ and try to do the build after running the following command: .. code-block:: bash docker login -u -p The alternative is to use a `paid subscription `__. If you're unable to resolve your issues, go to the `Support Forum `__. .. include:: ./introduction-to-the-edge-software-cli.rst