Repository: open-edge-platform/edge-microvisor-toolkit-standalone-node
Pull request #30: Update README.md
Author: login: abjyoti
Labels: name: root
name: standalone-node
Created: 2025-05-22T04:34:48Z | Merged: 2025-05-22T12:15:14Z

Updating Readme.md as per the OSS Checklist requirement.

# Pull Request Template

<!---
  SPDX-FileCopyrightText: (C) 2025 Intel Corporation
  SPDX-License-Identifier: Apache-2.0

  ------------------------------------------------------

  Author Mandatory (to be filled by PR Author/Submitter)
  ------------------------------------------------------

  - Developer who submits the Pull Request for merge is required to mark the
    checklist below as applicable for the PR changes submitted.
  - Those checklist items which are not marked are considered as not applicable
    for the PR change.
-->

## Description

Please include a summary of the changes and the related issue. List any dependencies
that are required for this change.

Fixes # (issue)

The Document is updated to meet open Source Release requirements, based on the review comments.

## Any Newly Introduced Dependencies

Please describe any newly introduced 3rd party dependencies in this change.
List their name, license information, and how they are used in the project.

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions
so we can reproduce. Please also list any relevant details for your test configuration.

## Checklist

- [x] I agree to use the APACHE-2.0 license for my code changes
- [x] I have not introduced any 3rd party dependency changes
- [x] I have performed a self-review of my code



Diff:
diff --git a/.markdownlintignore b/.markdownlintignore
index c5f562c7..7fe4fef3 100644
--- a/.markdownlintignore
+++ b/.markdownlintignore
@@ -4,10 +4,11 @@
 SECURITY.md
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md
-standaone-node/cluster_installers/docs/development-machine-usage.md
-standaone-node/cluster_installers/readme.md
-standaone-node/docs/user-guide/Get-Started-Guide.md
-standaone-node/docs/user-guide/Overview.md
-standaone-node/hook_os/readme.md
-standaone-node/installation_scripts/readme.md
+standalone-node/cluster_installers/docs/development-machine-usage.md
+standalone-node/cluster_installers/readme.md
+standalone-node/docs/user-guide/Get-Started-Guide.md
+standalone-node/docs/user-guide/Overview.md
+standalone-node/hook_os/readme.md
+standalone-node/installation_scripts/readme.md
 README.md
+standalone-node/docs/contribution.md
diff --git a/README.md b/README.md
index e3dff1e6..fac43aec 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,9 @@
-# Standalone Node Provisioning
+# Edge Microvisor Toolkit Standalone Node
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/badge)](https://scorecard.dev/viewer/?uri=github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node)
 
-The repository comprises the following components.
-
-## Standalone Node (SN)
-
-### Overview
+## Overview
 
 The Standalone Node solution, designed to enable Edge AI applications evaluation on Intel platform
 is designed to empower enterprise customers and developers by providing a rapid and efficient
@@ -15,3 +11,37 @@ means to familiarize, evaluate, and trial Edge AI applications on Intel Architec
 This comprehensive solution stack includes the edge-optimized immutable Edge Microvisor Toolkit,
 integrated with Kubernetes and foundational extensions, enabling the deployment of both cloud-native
 and legacy VM-based applications.
+
+## Get Started
+
+The repository comprises the following components.
+
+[**HookOS**](standalone-node/hook_os/): contains the Tinkerbell installation environment for bare-metal. It runs in-memory, installs operating system, and handles deprovisioning.
+
+[**Edge Microvisor Toolkit**](standalone-node/host_os/): Edge Microvisor toolkit immutable non-RT image as  hypervisor.
+
+[**Kubernetes Cluster**](standalone-node/cluster_installers): The Kubernetes RKE2 cluster is deployed along the cluster extensions
+
+For more details refer to [Get Started Guide](standalone-node/docs/user-guide/Get-Started-Guide.md).
+
+## Develop
+
+To develop one of the Managers, please follow its guide in README.md located in its respective folder.
+
+## Contribute
+
+To learn how to contribute to the project, see the Contributor's Guide.[Contributor's Guide](standalone-node/docs/contribution.md).
+
+## Community and Support
+
+To learn more about the project, its community, and governance, visit the Edge Orchestrator Community.
+
+For support, start with Troubleshooting [Troubleshooting section](standalone-node/docs/user-guide/Get-Started-Guide.md#troubleshooting).
+
+## License
+
+Each component of the Edge Microvisor Toolkit Standalone Node is licensed under [Apache 2.0][apache-license].
+
+Last Updated Date: May 22, 2025
+
+[apache-license]: https://www.apache.org/licenses/LICENSE-2.0
diff --git a/standalone-node/VERSION b/standalone-node/VERSION
index 9600efd3..672e5f5b 100644
--- a/standalone-node/VERSION
+++ b/standalone-node/VERSION
@@ -1 +1 @@
-1.0.38
+1.0.39
diff --git a/standalone-node/docs/contribution.md b/standalone-node/docs/contribution.md
new file mode 100644
index 00000000..94a6bbae
--- /dev/null
+++ b/standalone-node/docs/contribution.md
@@ -0,0 +1,45 @@
+# Contribute to Edge Microvisor Toolkit Standalone Node
+
+Edge Microvisor Toolkit Standalone Node is open source and always welcomes an active
+community to support adding new features, optimizing, and improving security.
+
+## Areas for Contribution
+
+The current release of the Intel® Edge Microvisor Toolkit Standalone Node supports the creation of bootable USB drives
+on Linux-based operating systems. This capability opens up several avenues for contribution:
+
+USB-Based Provisioning: Improve and optimize the process for creating bootable USB drives and
+develop tools and scripts that streamline the provisioning of the Standalone Node
+
+Feature Development: Innovate by adding new features or enhancing existing microvisor image to support more complex use cases.
+Kubernetes RKE2 clusters along with cluster extensions to enhance scalability, manageability, and orchestration capabilities
+
+Empowerment for Enterprise Customers and Developers:
+Provides the tools and infrastructure needed to explore and implement Edge AI solutions, empowering users
+to leverage Intel's architecture for advanced edge computing applications.
+
+## New Features
+
+New feature requests should always be made by opening an Architecture Decision Record (ADR)
+GitHub issue, regardless of whether you want to contribute directly or just file a request.
+To do so, use the [Design Proposal](TO DO :link to design proposal for SN) template
+and provide as much information as possible. This helps maintainers and stakeholders to
+review, better understand, and prioritize the request.
+
+## Contribution Flow
+
+The following diagram outlines the general workflow for pull requests made
+to the Edge Microvisor Toolkit Standalone Node repository:
+
+![Contribution Flow](submit-changes.drawio.png)
+
+## Release Cadence
+
+The Intel® Edge Microvisor Toolkit Standalone Node follows a regular release schedule, with updates every few weeks.
+Contributions are reviewed and integrated based on priority and alignment with upcoming releases.
+
+## Contribution license
+
+Since Edge Microvisor Toolkit Standalone Node is open source, by contributing to the project, you agree that
+your contributions will be licensed under the terms stated in the
+[LICENSES](../../LICENSES) file.
diff --git a/standalone-node/docs/submit-changes.drawio.png b/standalone-node/docs/submit-changes.drawio.png
new file mode 100644
index 00000000..e8d8b373
Binary files /dev/null and b/standalone-node/docs/submit-changes.drawio.png differ
diff --git a/standalone-node/docs/user-guide/Get-Started-Guide.md b/standalone-node/docs/user-guide/Get-Started-Guide.md
index a1233952..b498cfa9 100644
--- a/standalone-node/docs/user-guide/Get-Started-Guide.md
+++ b/standalone-node/docs/user-guide/Get-Started-Guide.md
@@ -54,7 +54,7 @@ cd edge-microvisor-toolkit-standalone-node
 - To create the standalone installation tar file with all required files for preparing a bootable USB device, run the following command
 
    ```bash
-   make build
+   sudo make build
 
    ```
 
@@ -375,6 +375,15 @@ Install a WordPress application as a test application using `helm`.
 
 ## Troubleshooting
 
+1. Creation of USB pendrive failed
+The possible reason could be USB device is mounted. Please unmount the USB drive and retry creating the bootable USB drive.
+
+2. If any issues while provisioning the microvisor from Hook OS, automatically logs will be collected
+ from /var/log/os-installer.log file on Hook OS what caused the OS provisioning failed.
+
+3. After sucessful installation A banner is printed at the end, summarizing the installation status and
+ providing useful commands/logs path for further management.
+
 ### Edge Node Logs from Developer's System
 
 ### Edge Node IP address


Reviews:
user: login: ipsita-npg
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T04:38:42Z
user: login: adorney99
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T09:19:43Z
user: login: ajaythakurintel
state: COMMENTED
author_association: NONE
submitted_at: 2025-05-22T10:00:24Z
user: login: ipsita-npg
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:11:22Z
user: login: ipsita-npg
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:33:58Z
user: login: Ram-srini
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:37:39Z
user: login: adorney99
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:45:16Z
user: login: ipsita-npg
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:45:32Z
user: login: Ram-srini
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T10:45:50Z
user: login: ipsita-npg
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T11:29:28Z
user: login: adorney99
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T11:30:13Z
user: login: Ram-srini
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-22T11:43:21Z

Review comments:
diff_hunk: @@ -1,17 +1,47 @@
-# Standalone Node Provisioning
+# Edge Microvisor Toolkit Standalone Node
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/badge)](https://scorecard.dev/viewer/?uri=github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node)
 
-The repository comprises the following components.
-
-## Standalone Node (SN)
-
-### Overview
+## Overview
 
 The Standalone Node solution, designed to enable Edge AI applications evaluation on Intel platform
 is designed to empower enterprise customers and developers by providing a rapid and efficient
 means to familiarize, evaluate, and trial Edge AI applications on Intel Architecture-based platforms.
 This comprehensive solution stack includes the edge-optimized immutable Edge Microvisor Toolkit,
 integrated with Kubernetes and foundational extensions, enabling the deployment of both cloud-native
 and legacy VM-based applications.
+
+## Get Started
+
+The repository comprises the following components.
+
+[**HookOS**](standalone-node/hook_os/): contains the Tinkerbell installation environment for bare-metal. It runs in-memory, installs operating system, and handles deprovisioning.
+
+[**Edge Microvisor Toolkit**](standalone-node/host_os/): Edge Microvisor toolkit immutable non-RT image as  hypervisor.
+
+[**Kubernetes Cluster**](standalone-node/cluster_installers): The Kubernetes RKE2 cluster is deployed along the cluster extensions
+
+For more details refer to [Get Started Guide](standalone-node/docs/user-guide/Get-Started-Guide.md).
+
+## Develop
+
+To develop one of the Managers, please follow its guide in README.md located in its respective folder.
+
+## Contribute
+
+To learn how to contribute to the project, see the Contributor's Guide.[Contributor's Guide](standalone-node/docs/contribution.md).
path: README.md
user: login: ajaythakurintel
body: see this repo  and refer common contributing guide - https://github.com/open-edge-platform/infra-core
created_at: 2025-05-22T10:00:24Z
author_association: NONE
diff_hunk: @@ -1,17 +1,47 @@
-# Standalone Node Provisioning
+# Edge Microvisor Toolkit Standalone Node
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/badge)](https://scorecard.dev/viewer/?uri=github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node)
 
-The repository comprises the following components.
-
-## Standalone Node (SN)
-
-### Overview
+## Overview
 
 The Standalone Node solution, designed to enable Edge AI applications evaluation on Intel platform
 is designed to empower enterprise customers and developers by providing a rapid and efficient
 means to familiarize, evaluate, and trial Edge AI applications on Intel Architecture-based platforms.
 This comprehensive solution stack includes the edge-optimized immutable Edge Microvisor Toolkit,
 integrated with Kubernetes and foundational extensions, enabling the deployment of both cloud-native
 and legacy VM-based applications.
+
+## Get Started
+
+The repository comprises the following components.
+
+[**HookOS**](standalone-node/hook_os/): contains the Tinkerbell installation environment for bare-metal. It runs in-memory, installs operating system, and handles deprovisioning.
+
+[**Edge Microvisor Toolkit**](standalone-node/host_os/): Edge Microvisor toolkit immutable non-RT image as  hypervisor.
+
+[**Kubernetes Cluster**](standalone-node/cluster_installers): The Kubernetes RKE2 cluster is deployed along the cluster extensions
+
+For more details refer to [Get Started Guide](standalone-node/docs/user-guide/Get-Started-Guide.md).
+
+## Develop
+
+To develop one of the Managers, please follow its guide in README.md located in its respective folder.
+
+## Contribute
+
+To learn how to contribute to the project, see the Contributor's Guide.[Contributor's Guide](standalone-node/docs/contribution.md).
path: README.md
user: login: ipsita-npg
body: @ajaythakurintel : The `edge-microvisor-toolkit-standalone-node` is designed to operate independently from the orchestrator. All `infra-*` components are integral parts of the orchestrator.
Additional links that are utilized by all orchestrator components are also included in the contribution. https://github.com/open-edge-platform/orch-docs/blob/main/docs/developer_guide/contributor_guide/code_contribution.rst

We made the decision that to create a seperate contribution.md file for `edge-microvisor-toolkit-standalone-node`
created_at: 2025-05-22T10:11:22Z
author_association: CONTRIBUTOR

PR comments:
user: login: ajaythakurintel
created_at: 2025-05-22T09:59:18Z
body: If nothing special in contributing.md file then use the common contributing file .. e.g. see README - https://github.com/open-edge-platform/infra-core 
author_association: NONE
user: login: ajaythakurintel
created_at: 2025-05-22T10:02:52Z
body: Please scan the repository for some of the forbidden words in the codebase. 
author_association: NONE
user: login: ajaythakurintel
created_at: 2025-05-22T10:05:44Z
body: We should provide link to standalone edge node from Open Edge Platform doc site https://docs.openedgeplatform.intel.com/edge-manage-docs/main/index.html 

This can be done; and doesn't require changes to this EMT-S repo.
author_association: NONE
user: login: abjyoti
created_at: 2025-05-22T10:30:34Z
body: > We should provide link to standalone edge node from Open Edge Platform doc site https://docs.openedgeplatform.intel.com/edge-manage-docs/main/index.html

> If nothing special in contributing.md file then use the common contributing file .. e.g. see README - https://github.com/open-edge-platform/infra-core

Example: infra-core contributor's guide links to many other unrleated links for EMT-S, hence this can't be useed and we have created dedicated Contributors guide. The EMT-Standalone is independent of EMF; Hence can't eb linked here and there.
author_association: CONTRIBUTOR
user: login: abjyoti
created_at: 2025-05-22T10:31:54Z
body: > Please scan the repository for some of the forbidden words in the codebase.
Thanks Ajay; fixing these issues with new PR.
author_association: CONTRIBUTOR
user: login: ipsita-npg
created_at: 2025-05-22T11:48:17Z
body: > > Please scan the repository for some of the forbidden words in the codebase.
> > Thanks Ajay; fixing these issues with new PR.

https://github.com/open-edge-platform/edge-microvisor-toolkit-standalone-node/pull/33
author_association: CONTRIBUTOR