open-amt-cloud-toolkit / docs

This repository holds the source content for the documentation rendered on github.io

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.

  

docs's Issues

Ports and Protocols exposed by each backend service

It would be great if we can add information on some of the below questions

• what ports are exposed by each backend service?
• what protocols does each service support?
• what ports do we need to expose publicly via API Gateway?
• what protocols do we need to support via API Gateway?
• do we need to passthrough any connections via API Gateway?

These are typical questions we get from ISV's trying to integrate Open AMT.

Docs should indicated when connecting with KVM won't work in CCM Mode

Needs to update sample webui documentation for local deployment

With local deployment, we need to update app_config.js file under sample-webui/src with mps and rps server ip addresses and port numbers, don't see those steps in documentaiton.

More plugin requirements for Local Development

I had to install mkdocs-macros-plugin and mkdocs-img2fig-plugin in order to run locally on macOS Monterey 12.2.

python version 3.8.9 and pip version 22.2.1

Getting started should note warning/error can be ignored

V 2.3.1 installed on macOS 12.2

Set Up Page

The "docker-compose pull" step may produce the following warning/error:

WARNING: Some service image(s) must be built from source by running:
    docker compose build db webui rps mps mpsrouter
Error response from daemon: pull access denied for sslpostgres, repository does not exist or may require 'docker login': denied: requested access to the resource is denied

It is tremendously confusing for those unfamiliar with Docker so the documentation should note that it can safely be ignored.

docs: broken link to troubleshooting section

/docs/Docker/overview.md: in Docker Configuration Details admonition.

Casing of MPS API responses don't match with sample responses in Swagger API doc

Casing of MPS API responses don't match with sample responses in Swagger API doc

Example:

Response of Audit logs API call

Response acc to swagger docs

Note: I've noticed casing issue with version API call as well. I think many other MPS API responses need to be updated.

Update EKS documentation with additional steps for deploying EBS CSI driver add-on

Customers have reported that additional EBS CSI driver add-on is required to create persistent volume for Vault. The attached document describes the steps needed to be included in EKS deployment instructions.

EKS extra steps.docx

OAMTCT to run within VMs

Describe the bug 🪲
Customer environments are running VMs only. No support for containers. Need to be able to install and support VMs.

To Reproduce 🪜
Need to document installation process for Open AMT Cloud Toolkit on VMs

Expected behavior
OAMTCT to install on VM

Screenshots 🖼️

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

Service Deployment (please complete the following information): ⛈️
VMs

Additional context
See Ganesh on details on VM installation.

Instructions on how to disable MPS Auth

I had a request from customer to add Instructions on how to disable MPS Auth, specifically around what env variables should be set to false.

”vault”(service name) and “IP address” should be added to the no_proxy variable(in docker-compose.yml file) for MPS, RPS and Vault containers

”vault”(service name) and “IP address” should be added to the no_proxy variable(in docker-compose.yml file) for MPS, RPS and Vault containers:
It is required when the setup is running in proxy environment.

Instructions on how to takeover a AMT device activated using MEBx

I got a request from a customer to add instructions on how to takeover a AMT device activated using MEBx. Would be great if we can add some pointers on how to do this.

UI toolkit tutorial has bad string for ui-toolkit-react version

The following is being displayed in the tutorial:

npm install @open-amt-cloud-toolkit/ui-toolkit-react@{{ no such element: dict object['ui_react'] }}

It seems that the automation of the current version number has failed. At the moment, I assume it should display:

npm install @open-amt-cloud-toolkit/[email protected]

Update documentation for Local TLS Configuration with RPC-Go

The Security Key instructions for this document needs to be updated.

Link to document here... https://open-amt-cloud-toolkit.github.io/docs/2.20/Reference/EA/localtlsconfig/?h=rpc

At number 5, the document needs to mention that the key length requirement must be at least 32 bytes long or at least 32 characters. I tested this with Madhavi and anything under 32bytes will not work.