Skip to content

Commit

Permalink
docs: console beta redesign (#482)
Browse files Browse the repository at this point in the history
* docs: console beta redesign

* docs: overhaul console beta with export feature

* docs: fix pics
  • Loading branch information
bwendlandt-intel authored Nov 6, 2024
1 parent 96ebe6a commit e0f667b
Show file tree
Hide file tree
Showing 65 changed files with 588 additions and 401 deletions.
2 changes: 1 addition & 1 deletion docs/Deployment/Database/nosql.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ NoSQL support is integrated using the MongoDB API. This does not just limit inte

## MongoDB Docker Deployment

The below steps will show how to modify the basic [Open AMT Getting Started Docker deployment](../../GetStarted/setup.md) to integrate MongoDB for MPS to store and reference device data.
The below steps will show how to modify the basic [Open AMT Getting Started Docker deployment](../../GetStarted/Cloud/setup.md) to integrate MongoDB for MPS to store and reference device data.

1. Stop any running containers. This will wipe all data and devices will have to be reprovisioned against the new RPS/MPS servers.

Expand Down
2 changes: 1 addition & 1 deletion docs/Deployment/centralizedConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The Consul configurations are stored in a local volume. When cleaning up contain
## Enable Consul
1. This guide assumes you have completed the [Getting Started Guide](../GetStarted/setup.md) and have Open AMT currently running in Docker containers. If not, follow the [Get Started Guide Setup page](../GetStarted/setup.md). Stop and return here after the your services are running.
1. This guide assumes you have completed the [Getting Started Guide](../GetStarted/Cloud/setup.md) and have Open AMT currently running in Docker containers. If not, follow the [Get Started Guide Setup page](../GetStarted/Cloud/setup.md). Stop and return here after the your services are running.
2. In the `.env`, enable Consul and Save.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ Developed in Go* programming language, the Remote Provisioning Client (RPC) appl

<div style="text-align:center;">
<iframe width="600" height="337" src="https://www.youtube.com/embed/z9Ia317L0Kk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<figcaption><b>Getting Started Part 3</b>: Follow along to learn about how to build RPC, some of the information it can provide, and how to activate an AMT device. <b>Additional Resources: </b><a href="../../Reference/RPC/libraryRPC">RPC as a Library</a> and <a href="../../Reference/RPC/commandsRPC">RPC Commands and Flags</a></figcaption>
<figcaption><b>Getting Started Part 3</b>: Follow along to learn about how to build RPC, some of the information it can provide, and how to activate an AMT device. <b>Additional Resources: </b><a href="../../../Reference/RPC/libraryRPC">RPC as a Library</a> and <a href="../../../Reference/RPC/commandsRPC">RPC Commands and Flags</a></figcaption>
</div>

!!! important "Important - Production Environment"
In a production environment, RPC can be deployed with an in-band manageability agent to distribute it to the fleet of AMT devices. The in-band manageability agent can invoke RPC to run and activate the AMT devices.


<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\RPC_Overview.png" alt="Figure 1: RPC Configuration">
<figcaption>Figure 1: RPC configuration</figcaption>
</figure>

!!! note "Figure 1 Details"
The RPC on a managed device communicates with the Intel® Management Engine Interface (Intel® MEI, previously known as HECI) Driver and the Remote Provisioning Server (RPS) interfaces. The Driver uses the Intel® MEI to talk to Intel® AMT. The RPC activates Intel® AMT with an AMT profile, which is associated with a CIRA configuration (Step 3). The profile, which also distinguishes between Client Control Mode (CCM) or Admin Control Mode (ACM), and configuration were created in [Create a CIRA Config](../GetStarted/createCIRAConfig.md) or [Create an AMT Profile](../GetStarted/createProfileACM.md). After running RPC with a profile, Intel® AMT will establish a CIRA connection with the MPS (Step 4) allowing MPS to manage the remote device and issue AMT commands (Step 5).
The RPC on a managed device communicates with the Intel® Management Engine Interface (Intel® MEI, previously known as HECI) Driver and the Remote Provisioning Server (RPS) interfaces. The Driver uses the Intel® MEI to talk to Intel® AMT. The RPC activates Intel® AMT with an AMT profile, which is associated with a CIRA configuration (Step 3). The profile, which also distinguishes between Client Control Mode (CCM) or Admin Control Mode (ACM), and configuration were created in [Create a CIRA Config](createCIRAConfig.md) or [Create an AMT Profile](createProfileACM.md). After running RPC with a profile, Intel® AMT will establish a CIRA connection with the MPS (Step 4) allowing MPS to manage the remote device and issue AMT commands (Step 5).

## Get RPC

Expand All @@ -42,7 +42,7 @@ After downloading, continue on to [Run RPC to Activate, Configure, and Connect t
Alternatively, the RPC-Go binaries can be manually built using Go for development purposes or personal preference.

??? tip "Flexible Deployment - RPC as a Library"
The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](../Reference/RPC/libraryRPC.md).
The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](../../Reference/RPC/libraryRPC.md).

If you are building an executable on a development system, you will copy the executable to the AMT device afterwards.

Expand Down Expand Up @@ -128,17 +128,17 @@ If you are building an executable on a development system, you will copy the exe
```
??? note "Note - Other RPC Flags and Commands"
See more about the [flags used here and the other available commands of RPC-Go](../Reference/RPC/commandsRPC.md).
See more about the [flags used here and the other available commands of RPC-Go](../../Reference/RPC/commandsRPC.md).
!!! success
<figure class="figure-image">
<img src="..\..\assets\images\RPC_Success.png" alt="Figure 2: Example output after configuration">
<img src="..\..\..\assets\images\RPC_Success.png" alt="Figure 2: Example output after configuration">
<figcaption>Figure 2: Example output after configuration</figcaption>
</figure>
!!! error "Troubleshooting"
Run into an issue? Try these [troubleshooting steps](../Reference/troubleshooting.md).
Run into an issue? Try these [troubleshooting steps](../../Reference/troubleshooting.md).
## Next up
**[Manage AMT Device](../GetStarted/manageDevice.md)**
**[Manage AMT Device](manageDevice.md)**
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Client Initiated Remote Access (CIRA) enables a CIRA-capable edge device to initiate and establish a persistent connection to the MPS. As long as the managed device is connected to the network and to a power source, it can maintain a persistent connection.

!!! note "Note - Wireless Activations"
This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../Tutorials/createWiFiConfig.md).
This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../../Tutorials/createWiFiConfig.md).

**To create a CIRA Config:**

1. Select the **CIRA Configs** tab from the left-hand menu.

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\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\RPS_CreateCIRAConfig.png" alt="Figure 2: Example CIRA Config">
<figcaption>Figure 2: Example CIRA Config</figcaption>
</figure>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,16 @@ Admin Control Mode (ACM) provides full access to Intel® Active Management Techn
- **Serial-over-LAN (SOL):** Manage devices with a command line interface (CLI) through SOL.
- **IDE Redirection:** Share and mount images remotely with a specified storage media (e.g., USB flash drive).

!!! Important "Important - IDE Redirection"
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\Profiles.png" 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>

### What You'll Need

#### Provisioning Certificate

By purchasing a certificate, you'll be able to remotely activate an Intel® AMT device in ACM. This feature enables you to disable User Consent. Provisioning Certificates are available from four different Certificate Authorities. [Find more information about Provisioning Certificates](../Reference/Certificates/remoteProvisioning.md).
By purchasing a certificate, you'll be able to remotely activate an Intel® AMT device in ACM. This feature enables you to disable User Consent. Provisioning Certificates are available from four different Certificate Authorities. [Find more information about Provisioning Certificates](../../Reference/Certificates/remoteProvisioning.md).

- [DigiCert](https://www.intel.com/content/www/us/en/support/articles/000055009/technologies.html)
- [Entrust](https://www.intel.com/content/www/us/en/support/articles/000055010/technologies/intel-active-management-technology-intel-amt.html)
Expand All @@ -27,7 +24,7 @@ By purchasing a certificate, you'll be able to remotely activate an Intel® AMT
!!! Important "Important - Intel AMT and using CAs"
For ACM in Open Active Management Technology (Open AMT) Cloud Toolkit, **use only** certificate vendors that support Intel® AMT.

Alternatively, for development, custom provisioning certificates can be generated. See [Custom Provisioning Certificate](../Reference/Certificates/generateProvisioningCert.md) for additional details.
Alternatively, for development, custom provisioning certificates can be generated. See [Custom Provisioning Certificate](../../Reference/Certificates/generateProvisioningCert.md) for additional details.

#### DNS Suffix
The DNS suffix encompasses the domain suffix (e.g., .com) and follows the hostname. Consider the following DNS Name example:
Expand All @@ -39,7 +36,7 @@ In this example, the hostname is **cb-vending1** and the DNS suffix is **burgerb

**To set the DNS suffix:**

1. Manually set it using MEBX on the managed device. Find instructions [here](../Reference/MEBX/dnsSuffix.md).
1. Manually set it using MEBX on the managed device. See [MEBx DNS Suffix](../../Reference/MEBX/dnsSuffix.md).

2. Alternately, change the DHCP Option 15 to DNS suffix within the Router settings.

Expand All @@ -65,7 +62,7 @@ A Profile provides configuration information to the AMT Firmware during the acti
In a production environment, devices are typically activated in ACM mode. ACM mode enables KVM access to devices without user consent. In most IoT use cases, edge devices such as digital signage or kiosks may not have immediate access to it or employees nearby. ACM mode proves immensely helpful in these scenarios.

??? note "Note - More Information about Passwords"
Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../Reference/architectureOverview.md#passwords).
Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../../Reference/architectureOverview.md#passwords).

**To create an ACM profile:**

Expand All @@ -74,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\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

Expand All @@ -95,7 +92,7 @@ A Profile provides configuration information to the AMT Firmware during the acti

9. Leave DHCP as the default for **Network Configuration**.

10. This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../Tutorials/createWiFiConfig.md).
10. This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../../Tutorials/createWiFiConfig.md).

11. Select **CIRA (Cloud)** for **Connection Configuration**.

Expand All @@ -107,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\RPS_CreateProfile_ACM.png" alt="Figure 3: Example ACM profile">
<figcaption>Figure 3: Example ACM profile</figcaption>
</figure>

Expand All @@ -123,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\RPS_NewDomain.png" alt="Figure 4: Create a new Domain profile">
<figcaption>Figure 4: Create a new Domain profile</figcaption>
</figure>

Expand All @@ -139,13 +136,13 @@ 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\RPS_CreateDomain.png" alt="Figure 5: Example Domain profile">
<figcaption>Figure 5: Example Domain profile</figcaption>
</figure>


## Next Up

**[Build & Run RPC](../GetStarted/buildRPC.md)**
**[Build & Run RPC](buildRPC.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\Profiles.png" 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 @@ -22,15 +22,15 @@ Profiles provide configuration information to the firmware on platforms featurin

??? note "Note - More Information about Passwords"

Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../Reference/architectureOverview.md#passwords).
Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../../Reference/architectureOverview.md#passwords).

**To create a CCM profile:**

1. Select the **Profiles** tab from the menu on the left.

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\RPS_NewProfile.png" alt="Figure 2: Create a new profile">
<figcaption>Figure 2: Create a new profile</figcaption>
</figure>

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

8. Leave DHCP as the default for **Network Configuration**.

9. This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../Tutorials/createWiFiConfig.md).
9. This express setup assumes the managed device (i.e. AMT device) is on a wired connection for quickest setup. To learn more about a Wireless Setup, see the [Wireless Activation Tutorial](../../Tutorials/createWiFiConfig.md).

10. Select **CIRA (Cloud)** for **Connection Configuration**.

Expand All @@ -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\RPS_CreateProfile.png" alt="Figure 3: Example CCM profile">
<figcaption>Figure 3: Example CCM profile</figcaption>
</figure>

Expand Down
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\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\WebUI_Home.png" alt="Figure 2: Sample Web UI Home Pageg">
<figcaption>Figure 2: Sample Web UI home page</figcaption>
</figure>
Expand Down
Loading

0 comments on commit e0f667b

Please sign in to comment.