Skip to content

Commit 64f39de

Browse files
krishnajscjnolansunil-paridajagratacRam-srini
authored
Modualr emf doc (#397)
* Add Modular Workflows docs section Introduce a new "Modular Workflows" documentation page and link: add docs/modular_workflows/index.rst and update docs/index.rst to include a grid card linking to the new page and add it to the toctree. The new content describes EMF device-management workflows showcasing Intel Architecture capabilities for independent evaluation and partner integration. * Add modular vPro workflow docs Add a new Modular vPro Workflow document (docs/modular_workflows/vpro-amt-ism/index.rst) and a grid card entry on the modular_workflows index. The new page documents an end-to-end deployment using Intel® vPro AMT and ISM, listing partner responsibilities, workflow capabilities (automated provisioning, automated vPro activation modes CCM/ACM), and out-of-band power management operations. * Move vPro deployment docs to new file Remove detailed deployment content from docs/modular_workflows/vpro-amt-ism/index.rst and add it to a new file docs/modular_workflows/vpro-amt-ism/modular-vpro-amt-ism-deployment.rst. The new file contains partner responsibilities, workflow capabilities (provisioning, activation modes CCM/ACM, OOB power management), system requirements, and evaluation deployment instructions — reorganizing the docs to keep the index concise and surface deployment details on a dedicated page. * Add deployment steps and partner developer notes Expand the vPro AMT ISM deployment docs with placeholder subsections for installation, verification, activation, power operations, and uninstallation of edge-node and control-plane components. Also add a Partner Developers section with guidance points describing the modular workflow structure and integration guidance for customers. These are scaffolding headings and high-level notes to be filled with detailed instructions. * Add architecture and process flow documentation * updated vpro doc * Revert "updated vpro doc" This reverts commit 881230d. * updated vpro doc updated vpro doc * Update modular-vpro-amt-ism-deployment.rst * updated doc * Update modular-vpro-amt-ism-deployment.rst * Update modular-vpro-amt-ism-deployment.rst * updated uninstall command * Updating ACM mode documentation * Add high-level architecture diagram * Remove trailing whitespaces * Update modular-vpro-amt-ism-deployment.rst * fix lint error --------- Co-authored-by: Christopher Nolan <christopher.nolan@intel.com> Co-authored-by: Sunil Parida <sunil.kumar.parida@intel.com> Co-authored-by: jagratac <jagrat.acharya@intel.com> Co-authored-by: Ramakrishna Srinivasamurthy <ramakrishna.srinivasamurthy@intel.com>
1 parent b96c4ad commit 64f39de

File tree

7 files changed

+609
-0
lines changed

7 files changed

+609
-0
lines changed

‎docs/index.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,22 @@ you can find details about the high-level design and submit patches of your own.
116116
APIs offer Create, Read, Update, and Delete capabilities.
117117

118118

119+
Modular Workflows
120+
-----------------
121+
Device management workflows from EMF that showcase Intel Architecture capabilities,
122+
designed to be evaluated independently and seamlessly integrated into partner
123+
device-management solutions to extend their functionality.
124+
125+
.. grid:: 3
126+
127+
.. grid-item-card:: Modular Workflows
128+
:link: modular_workflows/index
129+
:link-type: doc
130+
:link-alt: clickable cards
131+
132+
Explore modular device management workflows that extend partner solutions with Intel Architecture capabilities.
133+
134+
119135
.. toctree::
120136
:hidden:
121137

@@ -125,5 +141,6 @@ you can find details about the high-level design and submit patches of your own.
125141
developer_guide/index
126142
api/index
127143
system_requirements/index
144+
modular_workflows/index
128145

129146

‎docs/modular_workflows/index.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Modular Workflows
2+
=================
3+
4+
Device management workflows from EMF that showcase Intel Architecture
5+
capabilities, designed to be evaluated independently and seamlessly integrated
6+
into partner device-management solutions to extend their functionality.
7+
8+
.. grid:: 3
9+
10+
.. grid-item-card:: Modular vPro Workflow
11+
:link: vpro-amt-ism/index
12+
:link-type: doc
13+
:link-alt: clickable cards
14+
15+
End-to-end activation and device management using Intel® vPro AMT and ISM.
16+
17+
.. toctree::
18+
:hidden:
19+
20+
vpro-amt-ism/index

‎docs/modular_workflows/vpro-amt-ism/architecture.rst‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
Modular vPro Workflow Architecture
2+
==================================
3+
4+
Architecture Diagram
5+
--------------------
6+
7+
The modular vPro workflow makes use of components from the Edge Infrastructure
8+
Manager to provide an out-of-band (OOB) management pipeline for edge devices.
9+
The high level architecture of the workflow is shown in the following diagram:
10+
11+
.. figure:: images/modular-vpro-architecture.png
12+
:alt: High-Level Architecture of the modular vPro workflow
13+
14+
Key Components
15+
--------------
16+
17+
To enable the vPro device management for edge devices, the modular workflow
18+
uses the following Edge Infrastructure Manager services on the orchestrator:
19+
20+
`Inventory <https://github.com/open-edge-platform/infra-core/tree/main/inventory>`_ is the state store
21+
in Edge Infrastructure Manager. The modular vPro workflow uses the inventory service to store the
22+
status of edge devices, including the current state of the device as well as the desired state.
23+
24+
`API <https://github.com/open-edge-platform/infra-core/tree/main/apiv2>`_ provides a northbound REST based
25+
API that users and services can use to access Open Edge Platform services.
26+
27+
`Orchestrator Command Line Interface (CLI) <https://github.com/open-edge-platform/orch-cli>`_ is a utility
28+
which provides a command line interface that allows users to interact and manage the Orchestrator services
29+
using the REST API.
30+
31+
`Host Manager <https://github.com/open-edge-platform/infra-managers/tree/main/host>`_ is a service used to
32+
manager an edge node's hardware information. For the modular vPro workflow, this includes the status of the
33+
edge node device and the agents running there. The manager stores this information to inventory along with
34+
other information to identify the edge node.
35+
36+
`Device Management Manager <https://github.com/open-edge-platform/infra-external/tree/main/dm-manager>`_ is a service
37+
that provides integration between the Intel® vPro™ Active Management Technology (AMT) and Intel® Standard Manageability (ISM)
38+
on the edge node and the services provided by the Device Management Toolkit outlined below. This includes enabling
39+
remote management of edge node devices, allowing for remote power management and system configuration.
40+
41+
On the edge node device, the workflow requires the following agents:
42+
43+
`Device Discovery Agent <https://github.com/open-edge-platform/edge-node-agents/tree/main/device-discovery-agent>`_ is an
44+
agent deployed on the edge node that is responsible for discovering and registering that edge node with the Edge Infrastructure
45+
Manager during onboarding. This includes collecting system information from the edge node and handling authentication with
46+
the orchestrator. The agent can be run in either an interactive or non-interactive mode.
47+
48+
`Node Agent <https://github.com/open-edge-platform/edge-node-agents/tree/main/node-agent>`_ is an agent deployed on the edge node
49+
that is responsible for creating and refreshing any authentication tokens for agents running on the edge node. It also
50+
monitors the status of the edge node and the agents running on the node which it frequently reports to the Host Manager
51+
service in the Edge Infrastructure Manager.
52+
53+
`Platform Manageability Agent <https://github.com/open-edge-platform/edge-node-agents/tree/main/platform-manageability-agent>`_ manages
54+
platform level manageability features on the edge node. It integrates the Remote Provisioning Client service from the Device
55+
Management Toolkit and Intel® vPro™ to enable OOB device management capabilities on the edge node.
56+
57+
The vPro modular workflow also uses the following components from the `Device Management Toolkit (DMT) <https://device-management-toolkit.github.io/docs/2.31/Reference/architectureOverview/>`_
58+
on the orchestrator and edge node:
59+
60+
`Management Presence Server (MPS) <https://device-management-toolkit.github.io/docs/2.31/Reference/MPS/configuration/>`_ allows
61+
edge nodes which have support for Intel® AMT to connect securely to remote manageability services.
62+
63+
`Remote Provisioning Server (RPS) <https://device-management-toolkit.github.io/docs/2.31/Reference/RPS/configuration/>`_ is
64+
used to remotely connected to the Remote Provisioning Client service on an edge node device which supports Intel® AMT. It
65+
provides the required configuration profiles and settings needed to enable Intel® AMT for remote manageability of
66+
the device by MPS.
67+
68+
`Remote Prvosioning Client (RPC) <https://device-management-toolkit.github.io/docs/2.31/Reference/RPC/overview/>`_ is a
69+
lightweight application written in Go that is installed on the edge node device and interacts directly with
70+
Intel® AMT. It communicates with the RPS service and activates and manages Intel® AMT based on the
71+
configuration profiles and settings sent by RPS.

‎docs/modular_workflows/vpro-amt-ism/data_flow.rst‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
Data Flow
2+
=========
3+
4+
There are two primary flows of data in the modular vPro workflow:
5+
6+
1. **Top-down Requests**: These are driven by the user and are passed through
7+
the API or command line interface (CLI) through to the edge node.
8+
2. **Bottom-up Discovery**: These are driven from the edge node and are passed
9+
to the orchestrator services and are used to report changes on the edge node
10+
on a periodic basis.
11+
12+
The following diagram outlines how information flows in the modular vPro workflow
13+
between the agents and services at different stages:
14+
15+
.. note::
16+
17+
AMT/vPro has two modes for configuring edge node devices and activating them,
18+
Client Control Mode (CCM) and Admin Control Mode (ACM). The flow below outlines
19+
how the modular vPro workflow activates an edge node device when using ACM.
20+
For activating device in CCM, there is no need to include the creation of the
21+
Domain Profile. For more details on activating edge node devices with CCM profiles
22+
please see the `CCM documentation <https://device-management-toolkit.github.io/docs/2.31/GetStarted/Cloud/createProfileCCM/>`_
23+
in the Device Management Toolkit (DMT) documentation and for ACM activation, please
24+
see the `ACM documentation <https://device-management-toolkit.github.io/docs/2.31/GetStarted/Cloud/createProfileACM/>`_.
25+
26+
.. mermaid::
27+
28+
sequenceDiagram
29+
%%{wrap}%%
30+
autonumber
31+
32+
participant us as User
33+
participant cli as CLI
34+
box LightCyan Orchestrator
35+
participant api as API
36+
participant inv as Inventory
37+
participant dm as Device Management Manager
38+
participant rps as Remote Provisioning Server (RPS)
39+
end
40+
box LightGreen Edge Node
41+
participant pma as Platform Manageability Agent (PMA)
42+
participant rpc as Remote Provisioning Client (RPC)
43+
end
44+
45+
alt subscribe and listen for edge node creation events
46+
dm->>dm: Edge Node creation event received
47+
dm->>rps: Create CIRA configuration
48+
dm->>rps: Create CCM profile
49+
dm->>rps: Create ACM profile
50+
end
51+
note over pma: User updates edge node BIOS with DNS Suffix and MEBx Password
52+
us->>cli: Register the edge node
53+
node over cli: If no mode is specified by the user, CCM will be collected by default
54+
cli->>api: Register host with node serial number/hardware UUID as well as activation mode
55+
api->>inv: Create host and persist the host details in the inventory database
56+
inv->>api: Return response from host creation in inventory database
57+
api->>cli: Return response from host registration
58+
cli->>us: Return response from host registration
59+
node over pma: Periodically calls API to get activation request
60+
us->>cli: Activate AMT request for edge node
61+
cli->>api: Activate AMT request for edge node
62+
api->>inv: Set the Desired State for AMT for edge node to PROVISIONED
63+
inv->>api: Return response from activate AMT
64+
api->>cli: Return response from activate AMT
65+
cli->>us: Return response from activate AMT
66+
pma->>dm: Get AMT Activation Request
67+
dm->>inv: Query host to retrieve Activate AMT request from user
68+
inv->>dm: Return repsonse from activate AMT with desired state
69+
dm->>pma: Return response with profile name and details for AMT activation
70+
pma->>rpc: Trigger activation command using rpc binary and received profile
71+
rpc->>pma: Return activation command result
72+
pma->>dm: Report AMT activation status
73+
note over us: After device activation is completed, user can invoke AMT out of band operations
74+
75+
Top-down Requests
76+
-----------------
77+
78+
1. **Stage 1: Input**: User submits device onboarding/power on/power off requests via
79+
the CLI to the device management manager API.
80+
81+
2. **Stage 2: Processing and storage**: Data from user requests are sent to the inventory
82+
service and is processed and stored. An event is generated for the request and
83+
the modular vPro services are notified about the request.
84+
85+
3. **Stage 3: Service notifcation and consumption**: Services, during reconile stages, will
86+
detect the event created in the inventory service and act on the request as required.
87+
88+
Bottom-up Discovery
89+
-------------------
90+
91+
1. **Stage 1: Input**: Edge Node Agents push HW data from node up to manager services, which
92+
process and sends them to the inventory service.
93+
94+
2. **Stage 2: Processing and storage**: The inventory service processes the information from
95+
the agents, stores it and generates new events for the modular vPro services.
96+
97+
3. **Stage 3: Reconciliation**: The manager services (Host Manager, Device Management Manager, etc.)
98+
detect the events from the inventory service and perform reconciliation between the event
99+
data and the current data.

‎docs/modular_workflows/vpro-amt-ism/images/modular-vpro-architecture.png‎

377 KB
Loading

‎docs/modular_workflows/vpro-amt-ism/index.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Modular vPro Workflow Deployment
2+
================================
3+
4+
This workflow demonstrates an end-to-end activation and device-management
5+
process using Intel® vPro™ Active Management Technology (AMT) and
6+
Intel® Standard Manageability (ISM). It deploys modular components on both the
7+
control plane and the edge node to deliver out-of-band management capabilities.
8+
9+
.. toctree::
10+
:hidden:
11+
12+
architecture
13+
data_flow
14+
modular-vpro-amt-ism-deployment

0 commit comments

Comments
 (0)