# Get Started

This document is a quick start guide to configure and deploy nodes using the Edge Device
Enablement Framework on Intel® Core™ and Intel® Xeon® Scalable processors with Intel® Iris® Xe
Integrated Graphics for Core platform.

A shell script installs the Edge Device Enablement Framework software from the Open Edge
Platform (OEP)'s `edge-ai-libraries/frameworks` folder. Users can download the installer script
and deploy it to the Edge Node.

## Installation Flow for EEF

![Installation flow](_images/installation_flow.png)
*Figure 1: Flow for Edge Device Enablement Framework*

## Step 1: Prerequisites and System Setup

Before starting the Edge Node deployment, ensure you meet the following prerequisites:

- The system is bootable to a fresh Ubuntu OS 24.04 Long Term Support (LTS) version.
- Internet connectivity is available on the node.
- The hostname of the target node(s) uses only lowercase letters, numerals, and hyphens.
  - For example: "wrk-8" is acceptable; "wrk_8", "WRK8", and "Wrk^8" are not accepted as hostnames.
- The required proxy settings are added to the /etc/environment file.
- Secure boot uses the following BIOS settings:

   
   <details>
   <summary><code><b>Click to expand — BIOS Settings
   </b></code></summary>

    ::::{tab-set} 
    :::{tab-item}  **Dell R760**
    :sync: dell-r760 

   - BIOS Settings → System BIOS → System Security → Secure Boot → Enabled

    ::: 
    :::{tab-item}  **ASRock iEP-7020E or ASUS PE3000G**
    :sync: asrock-asus 

   - Press F2 → Go to UEFI Firmware Settings → Security Section → Secure Boot Section → Set Secure Boot Mode to Custom → Select Secure Boot → Enabled → Save Changes → Boot to setup.

   
   :::
   ::::
   </details>
   

## Step 2: Download the Script

1. [Download](https://raw.githubusercontent.com/open-edge-platform/edge-ai-libraries/main/frameworks/edgedevice-enablement-framework/base/va_enablement_node_profile/va_enablement_node_profile.sh) the Edge Device Enablement Framework script.

2. Download the file using wget:

   ```
   wget https://raw.githubusercontent.com/open-edge-platform/edge-ai-libraries/main/frameworks/edgedevice-enablement-framework/base/va_enablement_node_profile/va_enablement_node_profile.sh
   ```

## Step 3: Run the Script and Configure Command-line Options

- Modify the permissions of the installer file to make it executable:

  ```bash
  chmod +x va_enablement_node_profile.sh
  ```

- Use one of the following commands based on your use case. The available use cases are: Intel®
  Edge System Qualification (Intel® ESQ) and Metro, Transportation Fusion Compute Controller
  (TFCC) and Intel® Video Processing Platform Reference Implementation (VPP), Intel vPro® Platform,
  Edge Workloads and Benchmarks, and DevKit Component Set. See the details below:

   ::::{tab-set} 
   :::{tab-item}  **Intel® ESQ and Metro**
   :sync: esq-metro 

  ```bash
  ./va_enablement_node_profile.sh
  ```

   ::: 
   :::{tab-item}  **TFCC and VPP RI**
   :sync: tfcc-vpp-ri 

  ```bash
  ./va_enablement_node_profile.sh tfcc
  ./va_enablement_node_profile.sh vpp
  ```

   ::: 
   :::{tab-item}  **Intel vPro® Platform**
   :sync: vpro-platform 

  ```bash
  ./va_enablement_node_profile.sh vpro
  ```

   ::: 
   :::{tab-item}  **Edge Workloads and Benchmarks**
   :sync: edge-workloads-benchmarks 

  ```bash
  ./va_enablement_node_profile.sh magic9
  ```

   ::: 
   :::{tab-item}  **DevKit Component Set**
   :sync: devkit-component-set 

  ```bash
  ./va_enablement_node_profile.sh devkit
  ```

  
  :::
  ::::
  

- Execute the script with `--help` or `-h` to check the availability of any additional use
  case support:

  ```bash
  ./va_enablement_node_profile.sh -h
  ```

> **Note:** For Prometheus secure configuration details, see [Prometheus configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).

### User Inputs Required for Installer Execution


<details>
<summary><code>Click to expand — User Input
</code><code><b>VA Enablement Node
</b></code></summary>

| Prompt       | User Input                                                                                            |
| ------------ | ----------------------------------------------------------------------------------------------------- |
| Docker Group | For Metro/ESQ team enter 'yes', other users enter 'no'                                                |
| DL Streamer  | Do you want to install DL Streamer? (y/n) <br> (Comes up only for the DevKit command-line argument)   |
| XPU-SMI      | Do you want to install Intel XPU-SMI? (y/n) <br> (Comes up only for the DevKit command-line argument) |


</details>

## Step 4: Enable Time of Day (TOD) Provisioning

After the installer script finishes executing, follow these steps to deploy Time of Day (TOD) Provisioning:


<details>
<summary><code><b>Click to expand — Time of Day (TOD) Provisioning
</b></code></summary>

TOD enables power management provisioning to save power at a specific time of day, delivering power
savings during non-peak hours on the edge device by using the Intel® Infrastructure Power Manager
(IPM).
Download the [Time of Day Provisioning software package](https://www.intel.com/content/www/us/en/secure/content-details/828016/time-of-day-provisioning-with-intel-tiber-edge-platform.html?DocID=828016)
and the technology guide, available through the same link, as shown in Figure 2. To deploy this
feature, follow the instructions in Chapter 9 of the TOD technology guide.

![TOD](_images/tod.png)
*Figure 2: Time of Day Home Page*


</details>