Skip to content
Merged
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
75 changes: 49 additions & 26 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,84 @@
# Device Management Toolkit (formerly known as Open AMT Cloud Toolkit)
# Device Management Toolkit — Cloud Deployment

> **Looking for the legacy MPS-based deployment?** See the [`v2`](../../tree/v2) branch.

[![Discord](https://img.shields.io/discord/1063200098680582154?style=for-the-badge&label=Discord&logo=discord&logoColor=white&labelColor=%235865F2&link=https%3A%2F%2Fdiscord.gg%2FDKHeUNEWVH)](https://discord.gg/DKHeUNEWVH)

> 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
> Disclaimer: Production releases are tagged and listed under 'Releases'. Other check-ins should be considered in-development and should not be used in production.

Device Management Toolkit (formerly known as 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.
This repo contains deployment artifacts for **Device Management Toolkit (Console)** — the unified service replacing the historical MPS+RPS split. Console can be deployed in either a **cloud** or **on-prem** environment.

**For detailed documentation** about the Open AMT Cloud Toolkit, see the [docs].
For detailed documentation, see the [docs site][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):

```bash
git clone --recursive https://github.com/device-management-toolkit/cloud-deployment.git
```

Alternatively, for steps to clone and Get Started with one of the tagged releases, [see our documentation][docs].
The `--recursive` flag is required — this repo uses git submodules under `services/`.

## Get Started

There are multiple options to quickly deploy the Open AMT Cloud Toolkit:
### Local development with Docker Compose

### Option 1: Local using Docker
```bash
cp .env.template .env
# edit .env: set POSTGRES_PASSWORD, VAULT_TOKEN, AUTH_ADMIN_PASSWORD, AUTH_JWT_KEY, etc.
docker compose up -d
```

The quickest and easiest option is to set up a local stack using Docker, view our [Documentation Site][docs] and click the Get Started tab for How-To steps and examples.
### Cloud (Azure) deployment

### Option 2: Cloud using Azure
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdevice-management-toolkit%2Fcloud-deployment%2Fmain%2FazureDeploy.json)

For more experienced users, deploy the stack on Azure using the 'Deploy to Azure' button below.
Or via Azure CLI:

> 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.
```bash
az group create --name dmt-console --location eastus
az deployment group create --resource-group dmt-console --template-file azureDeploy.json
```

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdevice-management-toolkit%2Fcloud-deployment%2Fv2.5.0%2FazureDeploy.json)
> Migration to Bicep is planned. The current ARM template is retained for compatibility.

Optionally, deploy from AzureCLI using the following commands:
### Cloud Kubernetes (AKS, GKE, EKS) with Helm

```bash
az group create --name openamt --location eastus
az deployment group create --resource-group openamt --template-file azureDeploy.json
helm install console ./charts -f ./charts/values-cloud.yaml
```

Enables headless Console + sample-web-ui + kong API gateway + mps-router.

Additional deployments, such as Kubernetes via Azure (AKS) or AWS (EKS), can be found in our [Documentation Site][docs].
### On-prem Kubernetes with Helm

## Additional Resources
```bash
helm install console ./charts -f ./charts/values-onprem.yaml
```

Console with built-in UI; no kong, no sample-web-ui, no mps-router.

### On-prem native (macOS, Linux, Windows)

- For detailed documentation and Getting Started, [visit the docs site][docs].
See [`installers/`](./installers) for native installer status.

- Find a bug? Or have ideas for new features? [Open a new Issue](./issues).
## Repository Layout

- Discover a vulnerability or do you have a security concern? [See our Security policy](SECURITY.md) for our reporting process.
- `services/` — git submodules (Console, RPS, sample-web-ui, mps-router).
- `azureDeploy.json` — Azure ARM deployment.
- `charts/` — Helm chart with `values-cloud.yaml` and `values-onprem.yaml` overlays.
- `installers/` — Console native installers (on-prem).
- `docker-compose.yml` — local-dev / cloud-style stack.

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

- `main` (this branch) — v3 (Console-era), active development.
- `v2` — legacy MPS-era, minimum feature/maintenance only.

## Additional Resources

[![Discord Banner 1](https://discordapp.com/api/guilds/1063200098680582154/widget.png?style=banner2)](https://discord.gg/DKHeUNEWVH)
- [Documentation site][docs]
- [Open a new issue](./issues)
- [Security policy](SECURITY.md)
- [Discord](https://discord.gg/DKHeUNEWVH)

[docs]: https://device-management-toolkit.github.io/docs
Loading