Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
18 changes: 18 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"cSpell.words": [
"amtinfo",
"autoplay",
"BSOD",
"CCMP",
"CIRA",
"CMOS",
"IDER",
"MEBX",
"mpsrouter",
"PKCE",
"TKIP",
"vpro",
"vprodemo",
"webui"
]
}
2 changes: 1 addition & 1 deletion References/abbreviations.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

*[MPS]: Management Presence Server - A microservice that executes OOB Management REST APIs and receives keep-alive CIRA requests from managed devices.

*[MQTT]: Message Queuing Telemetry Transport - A lightweight publisher / subscriber network protocol for transfering messages between devices.
*[MQTT]: Message Queuing Telemetry Transport - A lightweight publisher / subscriber network protocol for transferring messages between devices.

*[OOB Management]: Out-of-band Management - A remote, hardware-based management technology that allows administrators to perform actions on network assets or devices using a secure alternative to LAN-based communication protocols regardless of OS state.

Expand Down
2 changes: 1 addition & 1 deletion docs/Deployment/Database/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Update the connection string and a folder name for your db either in your ENV or
1. Create a new folder in `./src/data`. The name of the new folder should be the name you supplied for the `db_provider` property, which is `mssql` in the example above.

<figure class="figure-image">
<img src="..\..\..\assets\images\DbFolder.png" alt="Figure 2: New folder mssql" style="width:224px">
<img src="..\..\..\assets\images\screenshots\DbFolder.png" alt="Figure 2: New folder mssql" style="width:224px">
<figcaption>Figure 2: New folder mssql</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/Deployment/centralizedConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,14 @@ The Consul configurations are stored in a local volume. When cleaning up contain
6. Click **Key/Value** from the left-hand menu.

<figure class="figure-image">
<img src="..\..\assets\images\Consul_KV_Overview.png" alt="Figure 1: Consul K/V Overview Page">
<img src="..\..\assets\images\screenshots\Consul_KV_Overview.png" alt="Figure 1: Consul K/V Overview Page">
<figcaption>Figure 1: Consul K/V Overview Page</figcaption>
</figure>

7. Choose either the `/MPS` or `/RPS` directory, then `/config`.

<figure class="figure-image">
<img src="..\..\assets\images\Consul_KV_MPS.png" alt="Figure 2: Consul K/V MPS Configuration">
<img src="..\..\assets\images\screenshots\Consul_KV_MPS.png" alt="Figure 2: Consul K/V MPS Configuration">
<figcaption>Figure 2: Consul K/V MPS Configuration</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Cloud/buildRPC.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Developed in Go* programming language, the Remote Provisioning Client (RPC) appl


<figure class="figure-image">
<img width="800" height="450" src="..\..\..\assets\images\RPC_Overview.png" alt="Figure 1: RPC Configuration">
<img width="800" height="450" src="..\..\..\assets\images\diagrams\RPC_Overview.svg" style="height:800px;"alt="Figure 1: RPC Configuration">
<figcaption>Figure 1: RPC configuration</figcaption>
</figure>

Expand Down Expand Up @@ -132,7 +132,7 @@ If you are building an executable on a development system, you will copy the exe

!!! success
<figure class="figure-image">
<img src="..\..\..\assets\images\RPC_Success.png" alt="Figure 2: Example output after configuration">
<img src="..\..\..\assets\images\screenshots\RPC_Success.png" alt="Figure 2: Example output after configuration">
<figcaption>Figure 2: Example output after configuration</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Cloud/createCIRAConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Client Initiated Remote Access (CIRA) enables a CIRA-capable edge device to init

2. In the top-right corner, click **Add New.**
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_NewCIRAConfig.png" alt="Figure 1: Create a new CIRA Config">
<img src="..\..\..\assets\images\screenshots\RPS_NewCIRAConfig.png" alt="Figure 1: Create a new CIRA Config">
<figcaption>Figure 1: Create a new CIRA Config</figcaption>
</figure>

Expand All @@ -32,7 +32,7 @@ Client Initiated Remote Access (CIRA) enables a CIRA-capable edge device to init

!!! example "Example CIRA Config"
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_CreateCIRAConfig.png" alt="Figure 2: Example CIRA Config">
<img src="..\..\..\assets\images\screenshots\RPS_CreateCIRAConfig.png" alt="Figure 2: Example CIRA Config">
<figcaption>Figure 2: Example CIRA Config</figcaption>
</figure>

Expand Down
10 changes: 5 additions & 5 deletions docs/GetStarted/Cloud/createProfileACM.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Admin Control Mode (ACM) provides full access to Intel® Active Management Techn
- **IDE Redirection:** Share and mount images remotely with a specified storage media (e.g., USB flash drive).

<figure class="figure-image">
<img src="..\..\..\assets\images\Profiles.png" alt="Figure 1: Set up configuration and profiles for N number of clients">
<img src="..\..\..\assets\images\diagrams\ProfileRelationshipsRPS.svg" style="height:800px;"alt="Figure 1: Set up configuration and profiles for N number of clients">
<figcaption>Figure 1: Set up configuration and profiles for n number of clients</figcaption>
</figure>

Expand Down Expand Up @@ -71,7 +71,7 @@ A Profile provides configuration information to the AMT Firmware during the acti
2. Under the **Profiles** tab, click **Add New** in the top-right corner to create a profile.

<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<img src="..\..\..\assets\images\screenshots\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

Expand Down Expand Up @@ -104,7 +104,7 @@ A Profile provides configuration information to the AMT Firmware during the acti

!!! example "Example ACM Profile"
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_CreateProfile_ACM.png" alt="Figure 3: Example ACM profile">
<img src="..\..\..\assets\images\screenshots\RPS_CreateProfile_ACM.png" alt="Figure 3: Example ACM profile">
<figcaption>Figure 3: Example ACM profile</figcaption>
</figure>

Expand All @@ -120,7 +120,7 @@ Intel® AMT checks the network DNS suffix against the provisioning certificate a

2. In the top-right corner, click **Add New.**
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_NewDomain.png" alt="Figure 4: Create a new Domain profile">
<img src="..\..\..\assets\images\screenshots\RPS_NewDomain.png" alt="Figure 4: Create a new Domain profile">
<figcaption>Figure 4: Create a new Domain profile</figcaption>
</figure>

Expand All @@ -136,7 +136,7 @@ Intel® AMT checks the network DNS suffix against the provisioning certificate a

!!! example "Example Domain"
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_CreateDomain.png" alt="Figure 5: Example Domain profile">
<img src="..\..\..\assets\images\screenshots\RPS_CreateDomain.png" alt="Figure 5: Example Domain profile">
<figcaption>Figure 5: Example Domain profile</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/GetStarted/Cloud/createProfileCCM.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ These features require user consent in CCM:
While AMT supports this feature, the toolkit doesn't natively support it.

<figure class="figure-image">
<img src="..\..\..\assets\images\Profiles.png" alt="Figure 1: Set up configuration and profiles for N number of clients">
<img src="..\..\..\assets\images\diagrams\ProfileRelationshipsRPS.svg" style="height:800px;" alt="Figure 1: Set up configuration and profiles for N number of clients">
<figcaption>Figure 1: Set up configuration and profiles for n number of clients</figcaption>
</figure>

Expand All @@ -30,7 +30,7 @@ Profiles provide configuration information to the firmware on platforms featurin

2. Under the **Profiles** tab, click **New** in the top-right corner to create a profile.
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<img src="..\..\..\assets\images\screenshots\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

Expand Down Expand Up @@ -61,7 +61,7 @@ Profiles provide configuration information to the firmware on platforms featurin

!!! example "Example CCM Profile"
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_CreateProfile.png" alt="Figure 3: Example CCM profile">
<img src="..\..\..\assets\images\screenshots\RPS_CreateProfile.png" alt="Figure 3: Example CCM profile">
<figcaption>Figure 3: Example CCM profile</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Cloud/loginToUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The web portal is available for login after the deployment of the MPS, RPS, and

!!! example "Example - Chrome* Browser Warning Message"
<figure class="figure-image">
<img src="..\..\..\assets\images\selfSignedConnect.png" alt="Figure 1: MPS Warning Message">
<img src="..\..\..\assets\images\screenshots\selfSignedConnect.png" alt="Figure 1: MPS Warning Message">
<figcaption>Figure 1: MPS warning message</figcaption>
</figure>

Expand All @@ -36,7 +36,7 @@ The web portal is available for login after the deployment of the MPS, RPS, and

!!! example "Example - Sample Web UI Home Page"
<figure class="figure-image">
<img src="..\..\..\assets\images\WebUI_Home.png" alt="Figure 2: Sample Web UI Home Pageg">
<img src="..\..\..\assets\images\screenshots\WebUI_Home.png" alt="Figure 2: Sample Web UI Home Page">
<figcaption>Figure 2: Sample Web UI home page</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/GetStarted/Cloud/manageDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

2. Click the Devices tab from the menu on the left.
<figure class="figure-image">
<img src="..\..\..\assets\images\MPS_ConnectedDevice.png" alt="Figure 1: Devices tab">
<img src="..\..\..\assets\images\screenshots\MPS_ConnectedDevice.png" alt="Figure 1: Devices tab">
<figcaption>Figure 1: Devices tab</figcaption>
</figure>

Expand All @@ -28,7 +28,7 @@
Turn off active redirection sessions, such as KVM or SOL, before specific power state transitions. Power Cycle (Code 5) and Unconditional Power Down (Power Off, Code 8) will be rejected as invalid if there is an active redirection session. Reset (Code 10) **will function** in KVM along with the [other unmentioned Power Actions](../../Reference/powerstates.md#out-of-band).

<figure class="figure-image">
<img src="..\..\..\assets\images\MPS_ManageDevice.png" alt="Figure 2: Action options">
<img src="..\..\..\assets\images\screenshots\MPS_ManageDevice.png" alt="Figure 2: Action options">
<figcaption>Figure 2: Action options</figcaption>
</figure>

Expand All @@ -41,7 +41,7 @@
1. When performing a KVM action for a device activated in CCM or ACM with user consent enabled, input the user consent code displayed on the client device.

<figure class="figure-image">
<img src="..\..\..\assets\images\MPS_UserConsent.png" alt="Figure 2: User Consent">
<img src="..\..\..\assets\images\screenshots\MPS_UserConsent.png" alt="Figure 2: User Consent">
<figcaption>Figure 3: User Consent</figcaption>
</figure>

Expand Down
2 changes: 1 addition & 1 deletion docs/GetStarted/Cloud/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Both systems must use a wired (i.e., cable) connection on the same network.
## What You'll Do

<figure class="figure-image">
<img width="800" height="450" src="..\..\..\assets\images\LocalDockerWorkflow.png" alt="Figure 1: Deploy microservices on a local development system as Docker containers">
<img width="800" height="450" src="..\..\..\assets\images\diagrams\LocalDockerWorkflow.svg" alt="Figure 1: Deploy microservices on a local development system as Docker containers">
<figcaption>Figure 1: Deploy microservices on a local development system as Docker containers</figcaption>
</figure>

Expand Down
2 changes: 1 addition & 1 deletion docs/GetStarted/Enterprise/activateDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ On the AMT device, download the latest RPC-Go version from the [RPC-Go GitHub Re

!!! success
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_DeviceActivation.png" alt="Figure 3: Example Successful Activation and Configuration">
<img src="..\..\..\assets\images\screenshots\Console_DeviceActivation.png" alt="Figure 3: Example Successful Activation and Configuration">
<figcaption>Figure 3: Example Successful Activation and Configuration</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Enterprise/addDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
2. In the upper-right, select **Add a Device**.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_AddDevices.png" alt="Figure 1: Add a New Device">
<img src="..\..\..\assets\images\screenshots\Console_AddDevices.png" alt="Figure 1: Add a New Device">
<figcaption>Figure 1: Add a New Device</figcaption>
</figure>

Expand Down Expand Up @@ -35,7 +35,7 @@

!!! example "Example - Add a New Device"
<figure class="figure-image">
<img width=600 src="..\..\..\assets\images\Console_AddDevice_Full.png" alt="Figure 2: Add a New Device Example">
<img width=600 src="..\..\..\assets\images\screenshots\Console_AddDevice_Full.png" alt="Figure 2: Add a New Device Example">
<figcaption>Figure 2: Add a New Device Example</figcaption>
</figure>

Expand Down
8 changes: 4 additions & 4 deletions docs/GetStarted/Enterprise/createProfileACM.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Intel® AMT checks the network DNS suffix against the provisioning certificate a

2. In the top-right corner, click **Add New.**
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_NewDomain.png" alt="Figure 4: Create a new Domain profile">
<img src="..\..\..\assets\images\screenshots\Console_NewDomain.png" alt="Figure 4: Create a new Domain profile">
<figcaption>Figure 4: Create a new Domain profile</figcaption>
</figure>

Expand All @@ -77,7 +77,7 @@ Intel® AMT checks the network DNS suffix against the provisioning certificate a

!!! example "Example Domain"
<figure class="figure-image">
<img src="..\..\..\assets\images\RPS_CreateDomain.png" alt="Figure 5: Example Domain profile">
<img src="..\..\..\assets\images\screenshots\RPS_CreateDomain.png" alt="Figure 5: Example Domain profile">
<figcaption>Figure 5: Example Domain profile</figcaption>
</figure>

Expand All @@ -96,7 +96,7 @@ A Profile provides configuration information to the AMT Firmware during the acti
2. Under the **Profiles** tab, click **Add New** in the top-right corner to create a profile.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_NewProfile.png" alt="Figure 2: Create a new profile">
<img src="..\..\..\assets\images\screenshots\Console_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

Expand Down Expand Up @@ -124,7 +124,7 @@ A Profile provides configuration information to the AMT Firmware during the acti

!!! example "Example ACM Profile"
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_NewACMProfile.png" alt="Figure 3: Example ACM profile">
<img src="..\..\..\assets\images\screenshots\Console_NewACMProfile.png" alt="Figure 3: Example ACM profile">
<figcaption>Figure 3: Example ACM profile</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Enterprise/createProfileCCM.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Profiles provide configuration information to the firmware on platforms featurin

2. Under the **Profiles** tab, click **New** in the top-right corner to create a profile.
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_NewProfile.png" alt="Figure 2: Create a new profile">
<img src="..\..\..\assets\images\screenshots\Console_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

Expand All @@ -48,7 +48,7 @@ Profiles provide configuration information to the firmware on platforms featurin

!!! example "Example CCM Profile"
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_NewCCMProfile.png" alt="Figure 3: Example CCM profile">
<img src="..\..\..\assets\images\screenshots\Console_NewCCMProfile.png" alt="Figure 3: Example CCM profile">
<figcaption>Figure 3: Example CCM profile</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/GetStarted/Enterprise/exportProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@
- For CCM profiles, Domain Profile selection is not required or prompted.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_ExportProfile.png" alt="Figure 1: Export Profile">
<img src="..\..\..\assets\images\screenshots\Console_ExportProfile.png" alt="Figure 1: Export Profile">
<figcaption>Figure 1: Export Button</figcaption>
</figure>

- For ACM profiles, you will be prompted to select a Domain Profile. If the target device is already activated in ACM, you can select 'Skip Domain', and the exported profile will not include a Domain Profile.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_ExportACMProfile.png" alt="Figure 1: Export ACM Profile">
<img src="..\..\..\assets\images\screenshots\Console_ExportACMProfile.png" alt="Figure 1: Export ACM Profile">
<figcaption>Figure 1: Export Button</figcaption>
</figure>

3. **Save the given Profile Key.** It is only given this once. This key is used by RPC-Go to decode the encrypted config file.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_ProfileKey.png" alt="Figure 2: Profile Key">
<img src="..\..\..\assets\images\screenshots\Console_ProfileKey.png" alt="Figure 2: Profile Key">
<figcaption>Figure 2: Profile Key</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/GetStarted/Enterprise/manageDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
1. Select the newly added AMT device.

<figure class="figure-image">
<img src="..\..\..\assets\images\Console_Devices.png" alt="Figure 1: Devices Tab">
<img src="..\..\..\assets\images\screenshots\Console_Devices.png" alt="Figure 1: Devices Tab">
<figcaption>Figure 1: Devices Tab</figcaption>
</figure>

Expand All @@ -18,7 +18,7 @@


<figure class="figure-image">
<img src="..\..\..\assets\images\Console_DeviceInfo.png" alt="Figure 2: Device Page and Options">
<img src="..\..\..\assets\images\screenshots\Console_DeviceInfo.png" alt="Figure 2: Device Page and Options">
<figcaption>Figure 2: Device Page and Options</figcaption>
</figure>

Expand Down
10 changes: 5 additions & 5 deletions docs/GetStarted/Enterprise/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
## What You'll Do

<figure class="figure-image">
<img src="..\..\..\assets\images\Device_Management_Toolkit_Console_Deployment.png" alt="Figure 1: Get Started with Console">
<img src="..\..\..\assets\images\diagrams\Console_Deployment.svg" style="height:800px" alt="Figure 1: Get Started with Console">
<figcaption>Figure 1: Get Started with Console</figcaption>
</figure>

**To complete a deployment:**

1. [Download and run Console](#get-console)
1. [Download and run Console](#download)
2. Create a [CCM Profile](createProfileCCM.md) or [ACM Profile](createProfileACM.md)
3. [Export Profile](exportProfile.md)
4. [Activate and configure an Intel® AMT device](activateDevice.md)
Expand All @@ -41,7 +41,7 @@

1. Run the executable, and a terminal will open containing the Console process.
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_Configuration_FirstTime.png" alt="Figure 2: Console Start">
<img src="..\..\..\assets\images\screenshots\Console_Configuration_FirstTime.png" alt="Figure 2: Console Start">
<figcaption>Figure 2: Console Start</figcaption>
</figure>

Expand Down Expand Up @@ -94,7 +94,7 @@

!!! success
<figure class="figure-image">
<img src="..\..\..\assets\images\Console_Start.png" alt="Figure 3: Console Process Startup">
<img src="..\..\..\assets\images\screenshots\Console_Start.png" alt="Figure 3: Console Process Startup">
<figcaption>Figure 3: Console Process Startup</figcaption>
</figure>

Expand All @@ -104,7 +104,7 @@

!!! example
<figure class="figure-image">
<img src="..\..\..\assets\images\DMT_Console_Login.png" alt="Figure 4: Console UI Startup">
<img src="..\..\..\assets\images\screenshots\DMT_Console_Login.png" alt="Figure 4: Console UI Startup">
<figcaption>Figure 4: Console UI Startup</figcaption>
</figure>

Expand Down
Loading