Skip to content

Commit 3af594c

Browse files
[DOCS] Present EMT Usage Scenarios in tabs (open-edge-platform#715)
* [DOCS] Present EMT usage scenarios in tabs * Update usage scenarios * Update menu and references
1 parent 134e975 commit 3af594c

File tree

11 files changed

+149
-49
lines changed

11 files changed

+149
-49
lines changed

docs/developer-guide/architecture/emt-extensions-and-patches.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Extensions And Patches
1+
# Extensions and Patches
22

33
Edge Microvisor Toolkit leverages a collection of extensions and patches
44
to provide more versatile deployment options and optimizations for Intel® silicon based AI
@@ -11,46 +11,56 @@ Deploying of Edge Microvisor Toolkit with Lightweight Kubernetes (K3s)
1111
requires additional extensions which are downloaded as docker images. Below is
1212
a list of components essential for scaled deployment of the toolkit.
1313

14-
### [Multus CNI](https://github.com/k8snetworkplumbingwg/multus-cni)
14+
### Multus CNI
1515

1616
A Container Network Interface (CNI) plugin for Kubernetes that enables you to
1717
attach multiple network interfaces to Kubernetes pods, which usually have only
18-
one network interface.
18+
one network interface. For more details, refer to the
19+
[GitHub page](https://github.com/k8snetworkplumbingwg/multus-cni).
1920

20-
### [Intel Device Plugins for Kubernetes](https://github.com/intel/intel-device-plugins-for-kubernetes)
21-
22-
[GPU Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/gpu_plugin/README.md)
21+
### Intel Device Plugins for Kubernetes
2322

2423
Intel GPU plugin provides access to discrete and integrated Intel GPU devices
2524
supported by the host kernel. It enables offloading compute operations of
2625
Kubernetes workload to GPU devices. It may be beneficial in such use cases as
2726
media transcoding and analytics, cloud gaming, AI training and inference.
27+
For more details, refer to the
28+
[GitHub page](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/gpu_plugin/README.md).
2829

29-
### [Calico](https://github.com/projectcalico/calico)
30+
### Calico
3031

31-
- [CNI Plugin](https://github.com/projectcalico/calico/tree/master/cni-plugin)
32-
\- as [docker image](https://hub.docker.com/r/calico/cni).
32+
- **CNI Plugin**
3333

34-
A plugin that enables you to use Calico for deployments based on Container
35-
Network Interface (CNI).
34+
[A plugin](https://github.com/projectcalico/calico/tree/master/cni-plugin)
35+
that enables you to use Calico for deployments based on Container
36+
Network Interface (CNI). It is available as a
37+
[docker image](https://hub.docker.com/r/calico/cni).
3638

37-
- [Node](https://github.com/projectcalico/calico/tree/master/node)
38-
\- as [docker image](https://hub.docker.com/r/calico/node/).
39+
- **Node**
3940

40-
A CNI plugin that enables you to create a Layer 3 network for Kubernetes
41-
pods and assign a unique IP address for each.
41+
[A CNI plugin](https://github.com/projectcalico/calico/tree/master/node)
42+
that enables you to create a Layer 3 network for Kubernetes
43+
pods and assign a unique IP address for each. Node is available as a
44+
[docker image](https://hub.docker.com/r/calico/node/)
4245

43-
- [Kube controllers](https://github.com/projectcalico/calico/tree/master/kube-controllers)
44-
\- as [docker image](https://hub.docker.com/r/calico/kube-controllers).
46+
- **Kube controllers**
4547

46-
A set of controllers that monitor the resources in the Kubernetes API (network,
47-
policies, nodes) and adjust Calico's CNI configuration.
48+
[A set of controllers](https://github.com/projectcalico/calico/tree/master/kube-controllers)
49+
that monitor the resources in the Kubernetes API (network,
50+
policies, nodes) and adjust Calico's CNI configuration. Kube controllers are
51+
available as a [docker image](https://hub.docker.com/r/calico/kube-controllers).
4852

4953

5054
## Patches
5155

52-
Below are listed quilt patchsets that include
53-
[Intel not-upstreamed kernel features](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/kernel/kernel.spec).
56+
Below is a list of
57+
[Intel not-upstreamed kernel features](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/kernel/kernel.spec).\
58+
Check the following quilt patchsets:
59+
60+
- [PREEMPT_RT](#preempt_rt)
61+
- [Time-Sensitive Networking (TSN)](#time-sensitive-networking-tsn)
62+
- [SR-IOV](#sr-iov)
63+
- [DRM](#drm)
5464

5565
### PREEMPT_RT
5666

docs/developer-guide/emt-architecture-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -455,10 +455,10 @@ for deployment instructions and full source code.
455455

456456
## Time-Sensitive Networking support
457457

458-
EMT supports time-sensitive networking through custom patches and optimizations in
458+
Edge Microvisor Toolkit supports time-sensitive networking through custom patches and optimizations in
459+
[the kernel](./architecture/emt-extensions-and-patches.md#time-sensitive-networking-tsn), the
459460
[linuxptp](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/linuxptp/linuxptp.spec), [ethtool](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/ethtool/ethtool.spec)
460-
and [xdp-tools](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/xdp-tools/xdp-tools.spec). Click on any of the names to go to
461-
their SPEC files and learn about specific patches related to TSN optimizations.
461+
and [xdp-tools](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/SPECS/xdp-tools/xdp-tools.spec) packages.
462462

463463
<!--hide_directive
464464
:::{toctree}

docs/developer-guide/emt-bootkit.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
:::
2-
orphan: true
3-
:::
1+
<!--hide_directive
2+
```{eval-rst}
3+
:orphan:
4+
```
5+
hide_directive-->
46

57
# Edge Microvisor Bootkit
68

@@ -18,7 +20,7 @@ the resulting image are defined in [edge-image-bootkit.json](https://github.com/
1820
as well as
1921
[Bootkit specific packages](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/toolkit/imageconfigs/packagelists/bootkit-packages.json).
2022

21-
Before you can build the image, make sure you have [installed prerequisites and built the toolchain](./get-started/emt-building-howto.md).
23+
Before you can build the image, make sure you have [installed prerequisites and built the toolchain](../get-started/emt-building-howto.md).
2224
To build the Bootkit OS image, run the following command:
2325

2426
```bash

docs/developer-guide/emt-contribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Edge Microvisor Toolkit Contribution Guide
1+
# Contribution Guide
22

33
Edge Microvisor Toolkit is open source and always welcomes an active
44
community to support adding new features, optimizing, and improving security.

docs/developer-guide/emt-get-started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ including remote deployment and management of applications orchestrated by Kuber
3737
:hidden:
3838
3939
./get-started/emt-versions.md
40+
./get-started/emt-installation-howto.md
4041
./get-started/emt-building-howto.md
4142
./get-started/emt-build-and-deploy.md
42-
./get-started/emt-installation-howto.md
43+
4344
:::
4445
hide_directive-->

docs/developer-guide/emt-security-considerations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Edge Microvisor Toolkit Security Considerations
1+
# Security Considerations
22

33
## EMT Security Overview
44

docs/developer-guide/emt-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Edge Microvisor Toolkit Troubleshooting
1+
# Troubleshooting
22

33
This section provides additional tips and suggestions for common questions
44
and issues users may run into.
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Tutorials
22

3-
This section contains tutorials for common tasks, including customization
4-
of a mutable developer node:
3+
This section contains tutorials for common tasks, including deployment and customization
4+
of the toolkit:
55

6+
- Learn how to [Deploy Edge Microvisor Toolkit with Edge Orchestrator](./tutorials/emt-deployment-edge-orchestrator.md).
67
- Learn how to [Enable Debugging with GDB in Edge Microvisor Toolkit Developer Node](./tutorials/emt-gdb-debugging.md).
78
- Learn how to [Enable X11 Desktop UI for Edge Microvisor Toolkit Developer Node](./tutorials/emt-x11-desktop-ui.md).
89

910
<!--hide_directive
1011
:::{toctree}
1112
:hidden:
1213
13-
./tutorials/emt-gdb-debugging.md
14-
./tutorials/emt-x11-desktop-ui.md
14+
./tutorials/emt-deployment-edge-orchestrator
15+
./tutorials/emt-gdb-debugging
16+
./tutorials/emt-x11-desktop-ui
17+
1518
:::
16-
hide_directive-->
19+
hide_directive-->

docs/developer-guide/get-started/emt-versions.md

Lines changed: 91 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,101 @@ suits your needs. To do so, check out:
1515
|--------|---------|-------------|------|
1616
| [**Standalone (Immutable)**](https://github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node) | Available for opt-in |||
1717
| [**Developer Node (Mutable)**](../emt-architecture-overview.md#developer-node-mutable-iso-image) | Optional |||
18-
| [**EMT for EMF**](../emt-deployment-edge-orchestrator.md) | Available for opt-in |||
18+
| [**EMT for EMF**](../tutorials/emt-deployment-edge-orchestrator.md) | Available for opt-in |||
1919
| [**Bootkit**](../emt-bootkit.md) | - |||
2020

2121
## How usage scenarios affect EMT setup
2222

23-
| Scenario | Description | Primary outcomes | Technology areas | Kernel patchset (quilts) |
24-
|---|---|---|---|---|
25-
| Real-time & deterministic workloads | Run latency-sensitive workloads with guaranteed bounded jitter and repeatable execution timelines across one or more hosts, maintainable under steady-state and failure-recovery conditions | <br> - Bounded end-to-end latency & jitter <br> - Repeatable scheduling windows under load <br> - Cross-host timing consistency for distributed stages <br> - Fast, predictable recovery without violating SLOs | <br> - [PREEMPT_RT kernel](../emt-architecture-overview.md#preempt-rt-kernel) <br> - [Resource Director Technologies](../emt-architecture-overview.md#resource-director-technology) <br> - [Intel GPU RT](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes) <br> - [CPU & Scheduler Isolation](../emt-architecture-overview.md#isolcpuslist) <br> - [Memory Determinism](../emt-architecture-overview.md#preempt-rt-kernel) <br> - Time & Clocks <br> - [Network Determinism (TSN)](../emt-architecture-overview.md#time-sensitive-networking-support) | - [PREEMPT_RT](../architecture/emt-extensions-and-patches.md#preempt_rt) <br> - [Time-Sensitive Networking](../architecture/emt-extensions-and-patches.md#time-sensitive-networking-tsn) |
26-
| VM-based workloads on Kubernetes with shared GPUs | Run multiple virtual machines on Kubernetes that concurrently share one or more physical GPUs, with predictable fairness, isolation, and policy-driven placement—using a KubeVirt stack extended for GPU sharing | <br> - Stable, repeatable GPU performance per VM under contention <br> - Hard/soft sharing policies (fair-share, priority tiers, or quotas) <br> - Safe isolation between tenants/VMs (memory, contexts, resets) <br> - Schedulable resources with clear admission signals (no surprise fails) <br> - Operational guardrails: health checks, graceful drain/eviction, rollback | <br> - [SRIOV](./deployment/emt-vm-host.md) <br> - [Intel GPU](../emt-system-requirements.md#discrete-gpu) <br> - [kubevirt](https://github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/blob/main/standalone-node/docs/user-guide/desktop-virtualization-image-guide.md) <br> - [Host virtualization](./deployment/emt-vm-host.md) <br> - [Intel GPU device plugin](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes) | - [SR-IOV](../architecture/emt-extensions-and-patches.md#sr-iov) <br> - [DRM](../architecture/emt-extensions-and-patches.md#drm)  |
27-
| AI & Vision workloads | Enable AI inference and computer-vision workloads on edge nodes using Intel GPU and NPU acceleration, exposing unified hardware-assisted pipelines through standard APIs and user-space libraries | <br> - Efficient execution of deep-learning and vision inference on-device without cloud dependency <br> - Unified GPU/NPU compute abstraction for developers (OpenVINO backend, media pipelines) <br> - Deterministic frame-rate and latency for multi-stream analytics workloads (e.g., camera ingest) <br> - Seamless integration with containers or pods, including dynamic device discovery and sharing <br> - Stable ABI/API interface across [OS updates](../architecture/emt-updates.md) and driver versions | <br> - [Edge AI packages](https://eci.intel.com/docs/3.3/packages_list.html) <br> - [OpenVino](https://docs.openvino.ai) <br> - [Intel GPU and NPU drivers](https://docs.openvino.ai/2025/openvino-workflow/running-inference/inference-devices-and-modes.html) <br> - [Intel GPU device plugin](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes) | |
23+
<!--hide_directive::::{tab-set}
24+
:::{tab-item}hide_directive--> Real Time & Deterministic
25+
<!--hide_directive:sync: tab1hide_directive-->
26+
\
27+
Run latency-sensitive workloads with guaranteed bounded jitter and repeatable
28+
execution timelines across one or more hosts, maintainable under steady-state
29+
and failure-recovery conditions.
30+
31+
*Primary outcomes:*
32+
33+
- Bounded end-to-end latency & jitter
34+
- Repeatable scheduling windows under load
35+
- Cross-host timing consistency for distributed stages
36+
- Fast, predictable recovery without violating SLOs
37+
38+
*Technology areas:*
39+
40+
- [PREEMPT_RT kernel](../emt-architecture-overview.md#preempt-rt-kernel)
41+
- [Resource Director Technologies](../emt-architecture-overview.md#resource-director-technology)
42+
- [Intel GPU RT](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes)
43+
- [CPU & Scheduler Isolation](../emt-architecture-overview.md#isolcpuslist)
44+
- [Memory Determinism](../emt-architecture-overview.md#preempt-rt-kernel)
45+
- [Network Determinism (TSN)](../emt-architecture-overview.md#time-sensitive-networking-support)
46+
- Time & Clocks
47+
48+
*Kernel patchsets (quilts):*
49+
50+
- [PREEMPT_RT](../architecture/emt-extensions-and-patches.md#preempt_rt)
51+
- [Time-Sensitive Networking](../architecture/emt-extensions-and-patches.md#time-sensitive-networking-tsn)
52+
53+
<!--hide_directive:::
54+
:::{tab-item}hide_directive--> Virtual Machines (Kubernetes, shared GPUs)
55+
<!--hide_directive:sync: tab2hide_directive-->
56+
\
57+
Run multiple virtual machines on Kubernetes that concurrently share one or more
58+
physical GPUs, with predictable fairness, isolation, and policy-driven placement—using
59+
a KubeVirt stack extended for GPU sharing.
60+
61+
*Primary outcomes:*
62+
63+
- Stable, repeatable GPU performance per VM under contention
64+
- Hard/soft sharing policies (fair-share, priority tiers, or quotas)
65+
- Safe isolation between tenants/VMs (memory, contexts, resets)
66+
- Schedulable resources with clear admission signals (no surprise fails)
67+
- Operational guardrails: health checks, graceful drain/eviction, rollback
68+
69+
*Technology areas:*
70+
71+
- [SRIOV](./deployment/emt-vm-host.md)
72+
- [Intel GPU](../emt-system-requirements.md#discrete-gpu)
73+
- [kubevirt](https://github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/blob/main/standalone-node/docs/user-guide/desktop-virtualization-image-guide.md)
74+
- [Host virtualization](./deployment/emt-vm-host.md)
75+
- [Intel GPU device plugin](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes)
76+
77+
*Kernel patchsets (quilts):*
78+
79+
- [SR-IOV](../architecture/emt-extensions-and-patches.md#sr-iov)
80+
- [DRM](../architecture/emt-extensions-and-patches.md#drm) 
81+
82+
83+
<!--hide_directive:::
84+
:::{tab-item}hide_directive--> AI & Vision Systems
85+
<!--hide_directive:sync: tab3hide_directive-->
86+
\
87+
Enable AI inference and computer-vision workloads on edge nodes using Intel GPU
88+
and NPU acceleration, exposing unified hardware-assisted pipelines through
89+
standard APIs and user-space libraries.
90+
91+
**Primary outcomes:**
92+
93+
- Efficient execution of deep-learning and vision inference on-device without
94+
cloud dependency
95+
- Unified GPU/NPU compute abstraction for developers (OpenVINO backend,
96+
media pipelines)
97+
- Deterministic frame-rate and latency for multi-stream analytics workloads
98+
(e.g., camera ingest)
99+
- Seamless integration with containers or pods, including dynamic device
100+
discovery and sharing
101+
- Stable ABI/API interface across [OS updates](../architecture/emt-updates.md)
102+
and driver versions
103+
104+
**Technology areas:**
105+
106+
- [Edge AI packages](https://eci.intel.com/docs/3.3/packages_list.html)
107+
- [OpenVino](https://docs.openvino.ai)
108+
- [Intel GPU and NPU drivers](https://docs.openvino.ai/2025/openvino-workflow/running-inference/inference-devices-and-modes.html)
109+
- [Intel GPU device plugin](../emt-architecture-overview.md#intel-device-plugins-for-kubernetes)
110+
111+
<!--hide_directive:::
112+
::::hide_directive-->
28113

29114
## How to build your own version of EMT
30115

docs/developer-guide/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ different use cases demonstrating how Intel processors can cost-effectively mini
1515
To select the right version for you, follow the article on
1616
[Edge Microvisor Toolkit Versions](./get-started/emt-versions.md).
1717

18-
For an immediate hands-on experience with no limitations, download the
18+
For an immediate hands-on experience with no limitations, download the
1919
[Developer Node ISO](https://files-rs.edgeorchestration.intel.com/files-edge-orch/microvisor/iso/EdgeMicrovisorToolkit-3.1.iso) and
2020
[install on a virtual machine](https://docs.openedgeplatform.intel.com/2025.2/edge-microvisor-toolkit/get-started/deployment/emt-vm-guest.html).
2121

@@ -70,12 +70,11 @@ document.
7070
7171
emt-get-started
7272
emt-architecture-overview
73-
emt-deployment-edge-orchestrator
74-
emt-bootkit
73+
emt-tutorials
7574
emt-security-considerations
7675
emt-contribution
7776
emt-troubleshooting
7877
emt-system-requirements
79-
emt-tutorials
78+
8079
:::
8180
hide_directive-->

0 commit comments

Comments
 (0)