open-amt-cloud-toolkit / sample-web-ui

The Sample WebUI provides an example of how the UI Toolkit can be implemented to leverage the OpenAMT Cloud Toolkit

Open AMT Cloud Toolkit

Disclaimer: Production viable releases are tagged and listed under 'Releases'. All other check-ins should be considered 'in-development' and should not be used in production

Open Active Management Technology Cloud Toolkit (Open AMT Cloud Toolkit) offers open-source microservices and libraries to streamline Intel AMT integration, simplifying out-of-band management solutions for Intel vPro Platforms.

For detailed documentation about the Open AMT Cloud Toolkit, see the docs.

Clone

Important! Make sure you clone this repo with the --recursive flag since it uses git submodules.

To clone live, in-development code (main branch):

git clone --recursive https://github.com/open-amt-cloud-toolkit/open-amt-cloud-toolkit.git

Alternatively, for steps to clone and Get Started with one of the tagged releases, see our documentation.

Get Started

There are multiple options to quickly deploy the Open AMT Cloud Toolkit:

Local using Docker

The quickest and easiest option is to set up a local stack using Docker*, view our Documentation Site and click the Getting Started tab for How-To steps and examples.

Cloud using Azure

For more experienced users, deploy the stack on Azure using the 'Deploy to Azure' button below. Note: This requires MPS, RPS, and Sample Web UI images to be built and accessible in a Container Image Registry such as Azure Container Registry (ACR), Docker Hub, or other options.

Optionally, deploy from AzureCLI using the following commands:

az group create --name openamt --location eastus
az deployment group create --resource-group openamt --template-file azureDeploy.json

Additional deployments, such as Kubernetes via Azure (AKS) or AWS (EKS), can be found in our Documentation Site.

Additional Resources

• For detailed documentation and Getting Started, visit the docs site.

• Find a bug? Or have ideas for new features? Open a new Issue.

• Need additional support or want to get the latest news and events about Open AMT? Connect with the team directly through Discord.

  

sample-web-ui's Issues

Add Configuration Mode and SKU Type of each machine in the "Devices" menu of the OpenAMT UI

Describe the bug 🪲
In the Device menu of the OpenAMT UI, add SKU Type and Configuration mode of the machine.

Expected behavior
When admin logs into the OpenAMT UI, and goes to the "Devices" menu, the list of systems should display the SKU type and Configuration mode.

Screenshots 🖼️

Additional context
Add any other context about the problem here.

Going to login page while logged in does not redirect to the dashboard

when visiting http://localhost:4200/login (or wherever the web-ui is hosted) while already logged in, the ui presents the login page with a functional navigation bar to the side. I'm guessing that this is unintended as the user should either have access or be presented with the login page but not both.

A simple redirect from the login page to the dashboard when the user is logged in should fix this issue.

I found this because I saved a bookmark for the login page and went there while already logged in

User should not be able to connect a device's KVM from multiple browser tabs at the same time

With previous version of code, it allowed only one KVM session at a time.

Add a Network Settings section in OpenAMT UI

Describe feature enhancement 🪲

When connecting to an AMT device in the OpenAMT UI, add a Network summary section.

Network Setting Information

Name & Domain - Example lenovo-moble1.vprodemo.com

Wired Interface
Link state - Link is up/Link is down
MAC Address - 8c-16-45-a5-9e-0f
802.1x - Enabled/Disabled
IPV4 state - DHCP/Static
IPV4 address - 10.0.0.52
IPV6 state - Enabled/Disabled
IPV6 address -

Wireless Interface
Link state - Link is up /Link is down
IPV4 address
IPV6 address
Wireless Profile - Profile name, SSID, Authentication, Encryption

To Reproduce 🪜
Steps to reproduce the behavior:

1. Go to OpenAMT UI
2. Click on Devices tab
3. Scroll down, to the Summary details of BIOS, Memory, Hardware
4. Network Settings Summary should be added under Memory Summary

Show About notice on Sample Web UI when a user logs in

As the product owner of the Open AMT Cloud Toolkit, I want the About message that is in the Sample Web UI to be shown every time a user logs into the page. This would ensure that users are notified that this is a sample ui, it's purpose, and that it should not be used in production. We'd also have a "Do not show this again" check box so that users could turn off the notice.

Acceptance Criteria:

• By default, when a user logs into the Sample UI, the About box is shown
• A "Do not show this again" check box is added to the About box. If this check box is checked, the Sample UI will not show the About message to the user when they log in

Add a UI mini-tutorial to Sample Web UI to show users what is new in the most recent update

As a user of Open AMT Cloud Toolkit, I would like the Sample Web UI to show me a brief tutorial of the new features that were added in the most recent version that I am running. This would be a one-time tutorial that would highlight the changes in the current version of Sample Web UI

Acceptance Criteria:

• Sample Web UI will provide a small tutorial in the UI showcasing the features added in the current version.
  - This would be small UI elements that provide a brief description of the change and are located near the changed item in the UI
  - The element would have a close option to end the tutorial
  - If there are multiple changes in the tutorial, the element will have a next button that will take them to the next tutorial step
• The Sample Web UI will only show the tutorial once, on first use.

Sample UI should abide by the user consent settings that are currently set in AMT

Currently, if AMT is set in Admin Control Mode and user consent is enabled, Sample UI automatically turns off user consent on AMT when a KVM session is started. Sample UI should not disable use consent.

• Add a prompt to KVM if it is disabled asking whether they need to enable or not
• Add a prompt to SOL if it is disabled asking whether they need to enable or not
• unit tests
• demo
• docs

Feature request - Edit machine tags

Discussed in open-amt-cloud-toolkit/open-amt-cloud-toolkit#218

^{Originally posted by aggietallboy July 28, 2023}
Howdy all!
I'm really liking the system as I've been using it more.
I'd like to be able to edit machine tags without having to create a whole different profile to do so.
Being able to add/remove tags from the device list would be very helpful (as we've already got filtering based on them!)

Logging out of Sample-Web-UI page while on an active KVM session does not take user back to login page

Steps to reproduce:

1. Start a KVM session on a device
2. Press the logout button for the Sample Web UI page
3. User will see a white screen

Expected behavior: user is taken back to the login screen

UI always shows "Certificate Not Yet Uploaded"

On the Domains page, the UI always shows Certificate Not Yet Uploaded even if the certificate is there

vPro "Pre-check" - Device specific page (See attachment) - Used for Support as well.

Feature Enhancement per customer request:

As discussed in the Monday morning "Matt's" meeting... this is request from a variety of customers to have a "pre-check" list of services and features listed to know that everything is running correctly or to be able to quickly identify what to resolve to remediate.

To Reproduce 🪜
NA

Expected behavior
NA

Screenshots 🖼️
Attached....

Dependency issue found in lodash 4.17.20

Link to issues on snyk:
https://snyk.io/vuln/SNYK-JS-LODASH-1040724
https://snyk.io/vuln/SNYK-JS-LODASH-1018905

Timing Issue with Enabling KVM

The first time visit to KVM component sends an initial request to enable KVM, and subsequently then requests to connect KVM. This is happening too fast and needs to be timed to wait for KVM to be enabled before connecting.

Missing RLE Encoder on sample-web-ui

Should have drop down to choose between RLE8 and RLE16 Encoding for KVM

Pages with multiple REST calls won't populate any information if a single call fails

When clicking on a connected device, multiple rest calls are executed to load the data on the device page (HW information, KVM information, Audit Log, Device Information). If one of those calls fails, none of the information from the other successfully executed calls is shown on the UI. For example, if the Audit Log call fails, the UI won't show HW or KVM information.

The UI should be updated to present information on the page as it is received. This way if any single call fails, the user still sees some of the information.

Please remove the snow effect. It wastes a lot of resources.

Please remove the snow introduced in https://github.com/open-amt-cloud-toolkit/sample-web-ui/releases/tag/v3.5.0. Here the browser is wasting precious resources showing all the 192 snow balls around.

Logging out of UI if user performs power actions on a device with invalid amt password

Using sample UI, it logs out when user performs power actions or click on device with invalid amt password.
Repro steps:

1. Activate in acm and configure cira to connect a device to open amt stack
2. In vault, change device amt password (create new version of secret with different password)
3. From sample-ui, either perform any device power action (or) click on a device, it gives an error and then logs out from UI.

Giving authentication error is expected but logging out of UI is not expected behavior.

Get 'Operation failed: Create [xxxx]' on Successful Creation

For all profiles (wireless, CIRA, profile, domain), you get a failed msg on success.

create edit dialog for tags

related to #1309

Show relevant items in UI only when applicable - Grey out all features that are not able to be used at that time

Describe the feature enhancement request 🪲
When using the OAMTCT UI, only show relevant fields (selectable items that will perform actions) that can be executed or performed at that time. Grey out all non-usable fields and/or selectable items when they are not usable.

To Reproduce 🪜
Example: When connected to a vPro device that is powered OFF, Sleep or Hibernate, you should only show the relevant button for POWER ON... Or POWER to BIOS, or POWER to PXE... all other fields, should be greyed out since they will not work.

Expected behavior
Only show features that are "Usable" at that moment... Basically giving our software a "Smart" aware like feature

Screenshots 🖼️

Example are CIRCLED BLUE would be active button and the others greyed out.

AMT Device (please complete the following information): 🖥️
N/A

Service Deployment (please complete the following information): ⛈️
N/A

Additional context
Add any other context about the problem here.

Error message misleading when using KVM in CCM Mode

It should be a warning to indicate that failing to change the User Consent mode is OK in CCM.

Feature request - show rps and mps version in sample-web-ui

Describe the bug 🪲
Would be great if we can see the deployed versions of RPS, MPS and MPS-Router if available in sample-web-ui. This will help us with debugging customer environments.

make call to MPS to update tags when changed

related to #1309

CIRA Config Name Smashed

Websocket Connection Failures should be propagated to UI

Describe the bug 🪲
Token was invalid, MPS rejecting connection, but wasn't indicated on UI

To Reproduce 🪜
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
I expect a notification if auth failed

Screenshots 🖼️
If applicable, add screenshots to help explain your problem.

Browser Information (please complete the following information): 🖥️

• OS: [e.g. Windows 10 build 21H1, Ubuntu 20.04 LTS] Win 11
• Browser and Version: [e.g. IE Edge 95.0.1020.40 ] Brave

Server Side Deployment (please complete the following information): ⛈️

• Deployment Type: [e.g. Azure, Docker, K8s] Docker
• Node Version: [e.g. LTS 14] LTS 16
• Component & Version: [e.g. RPS 2.0.0] 2.2.0

Additional context
Add any other context about the problem here.

KVM does not abide by user consent settings, and resets upon use

Latest version (06-23)
Built profile with user consent required for KVM
device showed up with new profile, but user consent set to none.
Connected to KVM without consent prompt.

Went back out, set kvm consent in gui on the device
Initially, after refresh, consent was none, but after a short period of time it did reflect "KVM"

Connected to KVM, without consent being asked/required - device setting was reverted back to none.

Can't clear out CIRA config once selected in AMT Profile

Workarounds:

Use the API to clear it out
Create a New Profile
Toggle Static/DHCP configuration for network to clear it out.

Versions are being requested before logging in

I want to be able to edit machine tags directly on the Sample UI

Currently machine tags can only be changed through a REST call. I would like the Sample UI to support me editing the machine tags

• create edit dialog for tags @matt-primrose
• make call to MPS to update tags when changed @rsdmike

WiFi Profiles drop-down says "No Wifi configs found" before typing anything

Need to type first letter of existing config for search to begin, and will work correctly after typing.

Issue while logging into RPS through Open AMT Cloud Toolkit Sample UI

Hi,

I deployed Intel AMT cloud toolkit microservices on Azure container instances by following this. The container instance got created and I can see all 6 containers running. However, when I use the FQDN to open the Web-UI and give the default username and password found here i am hitting an error : "ERROR LOGGING IN" .

I followed instructions given here to build MPS and RPS images and used docker build -t <tag> . command to build the sample Web-UI image.

Could you please help us?

cant login

My device can login to Intel AMT website(port 16992), but I cannot login to this sample web ui.
It always shows ERROR LOGGING IN
How can I login?

Display SKU type of each system in the OpenAMT UI Dashboard

Describe the Feature Request 🪲

On the OpenAMT Dashboard, create a bucket for vPro Enterprise, vPro Essentials and ISM devices. Under each bucket, list the number of systems there are.

Expected behavior
When admin logs into OpenAMT dashboard, all of the devices that are managed by OpenAMT, should be listed in each SKU type bucket.

Screenshots 🖼️

Additional context
ISV's are asking for this feature.

Integrate angular IDER and REST API

As a developer using the Sample Web UI as a reference for how to use the features of Open AMT Cloud Toolkit, I would like to have a sample implementation of IDER in the Sample Web UI so that I can use that as a template for how to integrate the IDER feature into my console.

Acceptance Criteria

• Dialogue on Sample Web UI to accept CD-ROM, Floppy Image File, & Mode of start mode (immediate, reboot) (see reference in mesh commander)
• Add instructional comments to UI toolkit integration

Tests fail if RPS server isn't localhost

To Reproduce 🪜
Steps to reproduce the behavior:

Change the environment to use a remote RPS server, for example:

diff --git a/src/environments/environment.ts b/src/environments/environment.ts
index 63d436c..7904a38 100644
--- a/src/environments/environment.ts
+++ b/src/environments/environment.ts
@@ -9,9 +9,9 @@
 
 export const environment = {
   production: false,
-  mpsServer: 'http://localhost:3000',
-  rpsServer: 'http://localhost:8081',
-  vault: 'http://localhost/vault'
+  mpsServer: 'https://10.0.0.219/mps',
+  rpsServer: 'https://10.0.0.219/rps',
+  vault: 'https://10.0.0.219/vault'
 }
 
 /*

The tests will fail as they have 'localhost' hardcoded in some strings.

Expected behavior

Tests should succeed.

Additional context

This will fix the problem. Using 'URL' to extract the hostname should be different enough to component.formServerUrl() for the test to be worthwhile.

diff --git a/src/app/shared/deactivate-device/deactivate-device.component.spec.ts b/src/app/shared/deactivate-device/deactivate-device.component.spec.ts
index babe200..cbd8909 100644
--- a/src/app/shared/deactivate-device/deactivate-device.component.spec.ts
+++ b/src/app/shared/deactivate-device/deactivate-device.component.spec.ts
@@ -51,7 +51,7 @@ describe('DeactivateDeviceComponent', () => {
     expect(component.rpcLinux).toBe('sudo ./rpc ')
     expect(component.rpcDocker).toBe('sudo docker run --device=/dev/mei0 rpc:latest ')
     expect(component.rpcWindows).toBe('rpc.exe ')
-    expect(component.deactivationUrl).toBe('sudo ./rpc -u wss://localhost/activate ')
+    expect(component.deactivationUrl).toBe('sudo ./rpc -u wss://' + new URL(environment.rpsServer).hostname + '/activate ')
     expect(component.serverUrl).toBe(`-u wss://${component.formServerUrl()}/activate `)
     expect(component.deactivationCommand).toBe('')
     expect(component.isCopied).toBe(false)
@@ -75,17 +75,17 @@ describe('DeactivateDeviceComponent', () => {
   it('should set linux deactivation url', () => {
     component.selectedPlatform = 'Linux'
     component.formDeactivationUrl()
-    expect(component.deactivationUrl).toBe('sudo ./rpc -u wss://localhost/activate ')
+    expect(component.deactivationUrl).toBe('sudo ./rpc -u wss://' + new URL(environment.rpsServer).hostname + '/activate ')
   })
   it('should set windows deactivation url', () => {
     component.selectedPlatform = 'wiNDows'
     component.formDeactivationUrl()
-    expect(component.deactivationUrl).toBe('rpc.exe -u wss://localhost/activate ')
+    expect(component.deactivationUrl).toBe('rpc.exe -u wss://' + new URL(environment.rpsServer).hostname + '/activate ')
   })
   it('should set docker deactivation url', () => {
     component.selectedPlatform = 'docker'
     component.formDeactivationUrl()
-    expect(component.deactivationUrl).toBe('sudo docker run --device=/dev/mei0 rpc:latest -u wss://localhost/activate ')
+    expect(component.deactivationUrl).toBe('sudo docker run --device=/dev/mei0 rpc:latest -u wss://' + new URL(environment.rpsServer).hostname + '/activate ')
   })
 
   it('should set the isCopied flag to true on click of copy icon ', fakeAsync(() => {

Need "Verification" on UI of Enterprise Activation Method (TLS Enterprise) with OAMTCT console

Describe the feature enhancement request
When using RPS/RPC to activate TLS Enterprise mode, need to be able to "Verify" or validate that the device being activated was indeed activated. Otherwise, activating in the dark and not knowing if it was successful.

To Reproduce 🪜
Activate a platform with TLS Enterprise mode (NON CIRA)...

Expected behavior
RPC to send back "Activation Status" or Activated or Failed... etc...

Screenshots 🖼️

AMT Device (please complete the following information): 🖥️
N/A

Service Deployment (please complete the following information): ⛈️
N/A

Additional context
Add any other context about the problem here.

AMT Responses should return status (i.e. NOT_READY) instead of "Sent Succesfully"

Messages should provide a bit more information as to the response of the AMT call instead of success/fail.

Add WSMAN Browser section in OpenAMT UI

Describe the feature enhancement 🪲
A clear and concise description of what the bug is.

When connecting to an AMT device in OpenAMT UI, add a section called "WSMAN Browser".

Add capabilities of the AMT platform. Refer to Mesh Commander.

To Reproduce 🪜
Steps to reproduce the behavior:

1. Go to OpenAMT UI
2. Click on the AMT configured device
3. Scroll down and add a section called "WSMAN Browser"
4. Add the capabilities to view what the platform supports. Refer to the Mesh Commander for these capabilities.

Additional context
Add any other context about the problem here.

We refer to these very often, to view the capabilities of the platform. Some recent examples, we recently needed to view if the plaform support OCR, 8021x profile, AMT Boot capabilities.