diff --git a/README.md b/README.md index 657eb42208..8542ec50f6 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ Check out these articles to quickly learn how to work with Edge Microvisor Toolk **Edge Microvisor Toolkit Developer Node** -* [Downloading and installing the developer toolkit ISO image](./docs/developer-guide/get-started.md#edge-microvisor-toolkit-developer) -* [Building a custom Edge Microvisor Toolkit image](./docs/developer-guide/get-started/building-howto.md) +* [Downloading and installing the developer toolkit ISO image](./docs/developer-guide/emt-get-started.md#edge-microvisor-toolkit-developer) +* [Building a custom Edge Microvisor Toolkit image](./docs/developer-guide/get-started/emt-building-howto.md) **Edge Microvisor Toolkit Standalone Node** @@ -43,12 +43,12 @@ Check out these articles to quickly learn how to work with Edge Microvisor Toolk **Common** -* [Hardware and software system requirements](./docs/developer-guide/system-requirements.md) -* [Installing EMT on bare metal edge node](./docs/developer-guide/get-started/installation-howto.md#bare-metal-with-iso) -* [Installing EMT on a Virtual Machine](./docs/developer-guide/get-started/installation-howto.md#virtual-machine-with-hyper-v) -* [Integrating the Edge Manageability Framework](./docs/developer-guide/deployment-edge-orchestrator.md) -* [Using the security features of the Edge Microvisor](./docs/developer-guide/security.md) -* [Troubleshooting common issues](./docs/developer-guide/troubleshooting.md) +* [Hardware and software system requirements](./docs/developer-guide/emt-system-requirements.md) +* [Installing EMT on bare metal edge node](./docs/developer-guide/get-started/emt-installation-howto.md#bare-metal-with-iso) +* [Installing EMT on a Virtual Machine](./docs/developer-guide/get-started/emt-installation-howto.md#virtual-machine-with-hyper-v) +* [Integrating the Edge Manageability Framework](./docs/developer-guide/emt-deployment-edge-orchestrator.md) +* [Using the security features of the Edge Microvisor](./docs/developer-guide/emt-security.md) +* [Troubleshooting common issues](./docs/developer-guide/emt-troubleshooting.md) ## Getting Help @@ -57,7 +57,7 @@ If you encounter bugs, have feature requests, or need assistance, Before submitting a new report, check the existing issues to see if a similar one has not been filed already. If no matching issue is found, feel free to file the issue as described -in the [contribution guide](./docs/developer-guide/contribution.md). +in the [contribution guide](./docs/developer-guide/emt-contribution.md). For security-related concerns, please refer to [SECURITY.md](./SECURITY.md). @@ -69,7 +69,7 @@ Microvisor Toolkit repository, for easier access. As an open-source project, Edge Microvisor Toolkit always looks for community-driven improvements. If you are interested in making the product even better, see how you can -help in the [contribution guide](./docs/developer-guide/contribution.md). +help in the [contribution guide](./docs/developer-guide/emt-contribution.md). ## License Information diff --git a/docs/developer-guide/assets/architecture-key-components.drawio.svg b/docs/developer-guide/assets/emt-architecture-key-components.drawio.svg similarity index 100% rename from docs/developer-guide/assets/architecture-key-components.drawio.svg rename to docs/developer-guide/assets/emt-architecture-key-components.drawio.svg diff --git a/docs/developer-guide/assets/architecture-update-flow.drawio.svg b/docs/developer-guide/assets/emt-architecture-update-flow.drawio.svg similarity index 100% rename from docs/developer-guide/assets/architecture-update-flow.drawio.svg rename to docs/developer-guide/assets/emt-architecture-update-flow.drawio.svg diff --git a/docs/developer-guide/assets/contribution-flow.drawio.svg b/docs/developer-guide/assets/emt-contribution-flow.drawio.svg similarity index 100% rename from docs/developer-guide/assets/contribution-flow.drawio.svg rename to docs/developer-guide/assets/emt-contribution-flow.drawio.svg diff --git a/docs/developer-guide/assets/luks-setup.drawio.svg b/docs/developer-guide/assets/emt-luks-setup.drawio.svg similarity index 100% rename from docs/developer-guide/assets/luks-setup.drawio.svg rename to docs/developer-guide/assets/emt-luks-setup.drawio.svg diff --git a/docs/developer-guide/assets/security-partitions.drawio.svg b/docs/developer-guide/assets/emt-security-partitions.drawio.svg similarity index 100% rename from docs/developer-guide/assets/security-partitions.drawio.svg rename to docs/developer-guide/assets/emt-security-partitions.drawio.svg diff --git a/docs/developer-guide/architecture-overview.md b/docs/developer-guide/emt-architecture-overview.md similarity index 99% rename from docs/developer-guide/architecture-overview.md rename to docs/developer-guide/emt-architecture-overview.md index be2fad390d..795a38b239 100644 --- a/docs/developer-guide/architecture-overview.md +++ b/docs/developer-guide/emt-architecture-overview.md @@ -21,7 +21,7 @@ The two immutable image microvisor versions integrate the Intel® kernel and enable the software and features offered by Intel® Open Edge Platform. Check out the overview of key software components: -![overview of key software components](./assets/architecture-key-components.drawio.svg) +![overview of key software components](./assets/emt-architecture-key-components.drawio.svg) ## Edge Microvisor Toolkit Real Time @@ -404,7 +404,7 @@ nodes. While the update will only occur during these maintenance windows, new im downloaded in the background as soon as they become available. The diagram below shows the overall update flow and state transitions. -![update flow and state transitions](./assets/architecture-update-flow.drawio.svg) +![update flow and state transitions](./assets/emt-architecture-update-flow.drawio.svg) The Edge Microvisor Toolkit may also be updated as a standalone solution, through a manual update procedure, without the automation offered by Open Edge Platform. You can download the diff --git a/docs/developer-guide/contribution.md b/docs/developer-guide/emt-contribution.md similarity index 96% rename from docs/developer-guide/contribution.md rename to docs/developer-guide/emt-contribution.md index a1f9b99e90..400b9507ab 100644 --- a/docs/developer-guide/contribution.md +++ b/docs/developer-guide/emt-contribution.md @@ -22,7 +22,7 @@ review, better understand, and prioritize the request. The following diagram outlines the general workflow for pull requests made to the Edge Microvisor Toolkit repository: -![Contribution Flow](assets/contribution-flow.drawio.svg) +![Contribution Flow](assets/emt-contribution-flow.drawio.svg) ## Release Cadence diff --git a/docs/developer-guide/deployment-edge-orchestrator.md b/docs/developer-guide/emt-deployment-edge-orchestrator.md similarity index 97% rename from docs/developer-guide/deployment-edge-orchestrator.md rename to docs/developer-guide/emt-deployment-edge-orchestrator.md index 4e743f5183..f3efa1804f 100644 --- a/docs/developer-guide/deployment-edge-orchestrator.md +++ b/docs/developer-guide/emt-deployment-edge-orchestrator.md @@ -36,5 +36,5 @@ process include: ## Learn More -- [Edge Microvisor Toolkit Architecture](architecture-overview.md) +- [Edge Microvisor Toolkit Architecture](emt-architecture-overview.md) - [Edge Manageability Framework](https://github.com/open-edge-platform/edge-manageability-framework) diff --git a/docs/developer-guide/get-started.md b/docs/developer-guide/emt-get-started.md similarity index 93% rename from docs/developer-guide/get-started.md rename to docs/developer-guide/emt-get-started.md index d13f3015aa..e4bfbb4ee0 100644 --- a/docs/developer-guide/get-started.md +++ b/docs/developer-guide/emt-get-started.md @@ -8,8 +8,8 @@ This section provides an overview of both the operating system and build pipelines. Once you have decided on the usage scenarios presented below, you can move on to: -- [Build a new Edge Microvisor Toolkit Image.](./get-started/building-howto.md) -- [Install Edge Microvisor Toolkit from existing image.](./get-started/installation-howto.md) +- [Build a new Edge Microvisor Toolkit Image.](./get-started/emt-building-howto.md) +- [Install Edge Microvisor Toolkit from existing image.](./get-started/emt-installation-howto.md) ## Usage Scenarios @@ -66,7 +66,7 @@ Manageability Framework: - Microvisor Immutable Image with Real Time For details on deploying Microvisor with Edge Manageability Framework, refer to -the [Edge Manageability Framework deployment guide](../user-guide/deployment-edge-orchestrator.md). +the [Edge Manageability Framework deployment guide](../user-guide/emt-deployment-edge-orchestrator.md). ## Image Support @@ -89,10 +89,10 @@ outlines the key differences between those. ## Next Steps - [System Requirements](./introduction) -- [Production Deployment with Edge Manageability Framework](./deployment-edge-orchestrator.md) +- [Production Deployment with Edge Manageability Framework](./emt-deployment-edge-orchestrator.md) :::{toctree} -./get-started/building-howto.md -./get-started/installation-howto.md -./get-started/sb-howto.md +./get-started/emt-building-howto.md +./get-started/emt-installation-howto.md +./get-started/emt-sb-howto.md ::: diff --git a/docs/developer-guide/security.md b/docs/developer-guide/emt-security.md similarity index 97% rename from docs/developer-guide/security.md rename to docs/developer-guide/emt-security.md index 06e4b18c3c..9591dedfb2 100644 --- a/docs/developer-guide/security.md +++ b/docs/developer-guide/emt-security.md @@ -19,7 +19,7 @@ implemented through platform fuses or other dedicated technologies. Each compone authenticated before the next stage loads. If any link cannot be verified, the boot process stops immediately to prevent potential tampering. -![System Partition](assets/security-partitions.drawio.svg) +![System Partition](assets/emt-security-partitions.drawio.svg) > **Note:** Measured Boot is a related mechanism that records cryptographic hashes (measurements) of @@ -52,7 +52,7 @@ stack is authenticated and tamper-resistant. Edge Microvisor Toolkit ensures that the software image remains immutable both at rest and during runtime. Once installed on an edge device, the image cannot be modified — whether on disk or while the system is running. Upgrades can only occur via a controlled, official -upgrade process (detailed in [architecture overview](./architecture-overview.md)), +upgrade process (detailed in [architecture overview](./emt-architecture-overview.md)), resulting in a secure and tamper-resistant operating system. Additionally, runtime modifications are actively prevented by built-in protection of the microvisor kernel. @@ -116,7 +116,7 @@ configured, data written to storage is automatically encrypted, and it is seamle when read by applications. This transparent process extends to the Linux swap partition, ensuring that cached data remains protected. -![Enabling Full Disc Encryption](./assets/luks-setup.drawio.svg) +![Enabling Full Disc Encryption](./assets/emt-luks-setup.drawio.svg) ### Key Management and Boot Process diff --git a/docs/developer-guide/system-requirements.md b/docs/developer-guide/emt-system-requirements.md similarity index 100% rename from docs/developer-guide/system-requirements.md rename to docs/developer-guide/emt-system-requirements.md diff --git a/docs/developer-guide/troubleshooting.md b/docs/developer-guide/emt-troubleshooting.md similarity index 98% rename from docs/developer-guide/troubleshooting.md rename to docs/developer-guide/emt-troubleshooting.md index c9347e6c2b..b1914e2dec 100644 --- a/docs/developer-guide/troubleshooting.md +++ b/docs/developer-guide/emt-troubleshooting.md @@ -155,7 +155,7 @@ It depends on which microvisor image you are using. :::: ::::{dropdown} What do the many JSON files in imageconfigs do? Which needs to be modified for the ISO or the immutable OS image? -For more details, see the [Build an Edge Microvisor Toolkit Image](./get-started/building-howto.md) +For more details, see the [Build an Edge Microvisor Toolkit Image](./get-started/emt-building-howto.md) article. The `imageconfigs` folder includes a set of different image files that define different image types the Buildkit can produce. For different validated images, Edge Microvisor Toolkit uses the `edge-image.json`, `edge-image-rt.json`, and image types the @@ -166,5 +166,5 @@ Buildkit can produce. To install from a USB device, you need to update BIOS to include the USB boot option and make sure USB boot has highest precedence in the boot order list. You also need to configure BIOS with the Platform Keys (PK) to enable -[secure boot](./get-started/sb-howto.md) for Edge Microvisor Toolkit. +[secure boot](./get-started/emt-sb-howto.md) for Edge Microvisor Toolkit. :::: \ No newline at end of file diff --git a/docs/developer-guide/get-started/building-howto.md b/docs/developer-guide/get-started/emt-building-howto.md similarity index 98% rename from docs/developer-guide/get-started/building-howto.md rename to docs/developer-guide/get-started/emt-building-howto.md index e27bb70fca..fb9e929396 100644 --- a/docs/developer-guide/get-started/building-howto.md +++ b/docs/developer-guide/get-started/emt-building-howto.md @@ -307,7 +307,7 @@ please raise a PR and work with a code owner to upload the source tarball to pac make build-packages # to rebuild the packages ``` -Follow the steps under [Customizing an image](./building-howto.md#Customizing-an-Image) to create +Follow the steps under [Customizing an image](./emt-building-howto.md#Customizing-an-Image) to create an image with your new package. **Uploading the archive** @@ -358,5 +358,5 @@ Example : `sha256sum ./SPECS/node-agent/env_wrapper.sh` ``` ## Next -- Learn how to [Enable Secure Boot for Edge Microvisor Toolkit](sb-howto.md). +- Learn how to [Enable Secure Boot for Edge Microvisor Toolkit](emt-sb-howto.md). - See the detailed description of how to [create a full build and customize it](https://github.com/open-edge-platform/edge-microvisor-toolkit/blob/3.0/toolkit/docs/building/add-package.md). diff --git a/docs/developer-guide/get-started/installation-howto.md b/docs/developer-guide/get-started/emt-installation-howto.md similarity index 99% rename from docs/developer-guide/get-started/installation-howto.md rename to docs/developer-guide/get-started/emt-installation-howto.md index 1b0199a9d5..d6d301dcc8 100644 --- a/docs/developer-guide/get-started/installation-howto.md +++ b/docs/developer-guide/get-started/emt-installation-howto.md @@ -225,5 +225,5 @@ now ready to use the EMT 3.0 image! ## Next -- Learn how to [Enable Secure Boot for Edge Microvisor Toolkit](sb-howto.md). -- Learn how to customize and manually [build microvisor images](building-howto.md). +- Learn how to [Enable Secure Boot for Edge Microvisor Toolkit](emt-sb-howto.md). +- Learn how to customize and manually [build microvisor images](emt-building-howto.md). diff --git a/docs/developer-guide/get-started/sb-howto.md b/docs/developer-guide/get-started/emt-sb-howto.md similarity index 100% rename from docs/developer-guide/get-started/sb-howto.md rename to docs/developer-guide/get-started/emt-sb-howto.md diff --git a/docs/developer-guide/index.rst b/docs/developer-guide/index.rst index 1282241d1b..ccce830534 100644 --- a/docs/developer-guide/index.rst +++ b/docs/developer-guide/index.rst @@ -114,13 +114,13 @@ document. Next Steps +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -:doc:`Architecture Overview <./architecture-overview>` +:doc:`Architecture Overview <./emt-architecture-overview>` .. toctree:: - get-started - architecture-overview - deployment-edge-orchestrator - security - contribution - troubleshooting - system-requirements + emt-get-started + emt-architecture-overview + emt-deployment-edge-orchestrator + emt-security + emt-contribution + emt-troubleshooting + emt-system-requirements