diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000000..33da179a19 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,38 @@ +# Tweak the template from super-linter from here: +# https://github.com/super-linter/super-linter/blob/main/TEMPLATES/.markdown-lint.yml + +########################### +########################### +## Markdown Linter rules ## +########################### +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint +# +# Note: +# To comment out a single error: +# +# any violations you want +# +# + +############### +# Rules by id # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: + line_length: 400 # Line length 80 is far too short + tables: false +MD026: + punctuation: ".,;:!。，；:" # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines diff --git a/README.md b/README.md index 938e76c808..8f4e1f62d7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ The currently published versions are: * Edge Microvisor Toolkit with real time extensions (immutable) * Edge Microvisor Toolkit Standalone (immutable) * Edge Microvisor Toolkit Developer (mutable) - + The Edge Microvisor Toolkit has undergone extensive validation across all Intel platforms such as Xeon®, Intel® Core Ultra™, Intel Core™ and Intel® Atom®. It provides robust support for integrated and Intel discrete GPU cards, as well as @@ -34,13 +34,13 @@ Check out these articles to quickly learn how to work with Edge Microvisor Toolk * [System requirements](./docs/developer-guide/system-requirements.md) for the hardware and software requirements. +* [Download](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipeµserviceNameForUrl=edge--microvisor-toolkit-development-node) and [install the developer ISO image](./docs/developer-guide/get-started.md#edge-microvisor-toolkit-developer) + for a mutable container host providing only minimum functionality. +* [Download](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipeµserviceNameForUrl=edge-microvisor-toolkit-standalone-node) and [install the production RAW image]( ./docs/developer-guide/get-started.md#edge-microvisor-toolkit-standalone) + for an immutable container host with essential functionality. * [Install on bare metal edge node](./docs/developer-guide/get-started/installation-howto.md#baremetal-with-iso) or [Install on a Virtual Machine](./docs/developer-guide/get-started/installation-howto.md#virtual-machine-with-hyper-v) to learn how to install Edge Microvisor Toolkit. -* [Install the developer ISO image](./docs/developer-guide/get-started.md#standalone-developer-edge-node) - for a mutable container host providing only minimum functionality. -* [Install the production RAW image]( ./docs/developer-guide/get-started.md#standalone-edge-node) - for an immutable container host with essential functionality. * [Build or customize the Edge Microvisor](./docs/developer-guide/get-started/building-howto.md) for maximum control over the system you want to deploy. * [Edge Manageability Framework integration](./docs/developer-guide/deployment-edge-orchestrator.md) diff --git a/docs/developer-guide/contribution.md b/docs/developer-guide/contribution.md index 2fb98cd795..a1f9b99e90 100644 --- a/docs/developer-guide/contribution.md +++ b/docs/developer-guide/contribution.md @@ -24,49 +24,6 @@ to the Edge Microvisor Toolkit repository: ![Contribution Flow](assets/contribution-flow.drawio.svg) -### Update of Edge Node Agents - -1. If a new package has to be released, follow these steps to ensure the package is available - in the artifactory: - - a. Checkout the tag for your agent which has to be released. - b. cd into your agent's directory. - c. Invoke `make tarball`. - d. Upload tarball from `build/artifacts` to the tarball repository. - -2. Update the respective .spec file in SPECS/`package` directory. Example: `SPECS/node-agent`. - -3. Bump the release number declared in the top section of the .spec file if on the same - version. Otherwise, update the release version and set the number to 1. - -4. Update `env_wrapper.sh` and the .spec file if there are installation changes or new - configurations to be added. - -5. Update the changelog to ensure the version and release number are mentioned correctly as - well. Example: - - ```bash - * Tue Mar 25 2025 Andrea Campanella - 1.5.11-2 - - Move from RSTYPE to RS_TYPE in wrapper for node-agent - ``` - -6. Generate sha256sum of all files that have been updated. -Example : `sha256sum ./SPECS/node-agent/env_wrapper.sh` - -7. Update the signature file name `.signatures.json`. Example: `node-agent.signatures.json`. - -8. Update `cgmanifest.json`. You can use a script to do it, if you have an RPM environment. - Otherwise, update the version and download the URL manually. Example commands to update - using a manifest: - - ```bash - python3 -m pip install -r ./toolkit/scripts/requirements.txt - python3 ./toolkit/scripts/update_cgmanifest.py first cgmanifest.json ./SPECS/node-agent/node-agent.spec - ``` - -> **Note:** - This guide applies to `rpm` package addition in general for Edge Microvisor. - ## Release Cadence Edge Microvisor Toolkit has a steady and predictable release cadence. Both issues and diff --git a/docs/developer-guide/get-started.md b/docs/developer-guide/get-started.md index 30cb576bcf..fc774a13ae 100644 --- a/docs/developer-guide/get-started.md +++ b/docs/developer-guide/get-started.md @@ -26,7 +26,7 @@ applications. To create a custom developer build of Edge Microvisor Toolkit, follow these steps: - Download the mutable host ISO image from - [Edge Software Catalog](https://edgesoftwarecatalog.intel.com/) + [Intel® Edge Software Catalog](https://edgesoftwarecatalog.intel.com/details/?microserviceType=recipeµserviceNameForUrl=edge--microvisor-toolkit-development-node). - Install the mutable host via ISO image that includes only essential pre-installed packages, providing a ready-to-use base environment. - Install additional RPM packages, using DNF to tailor the OS to your specific needs. @@ -55,6 +55,9 @@ monitoring tools, standard cloud-edge (CNCF) software, and more. ### Edge Microvisor Toolkit Standalone +The ISO installer for the standalone Edge Node is available for download at +[Intel® Edge Software Catalog](https://edgesoftwarecatalog.intel.com/package/edge_microvisor_toolkit_standalone_node). + The standalone edge node uses the standard immutable build and provides an ISO image that can be flashed to a USB device and installed on edge nodes. It installs the microvisor and Kubernetes to the edge node with the essential @@ -77,9 +80,6 @@ extensions. After the OS is installed, they are deployed on a writable section o filesystem. Image and orchestration system updates are currently not natively enabled. ::: -The ISO installer for the standalone Edge Node is available for download at -[Intel® Edge Software Hub](https://edgesoftwarecatalog.intel.com/). - ### Edge Microvisor Toolkit with Edge Manageability Framework Edge Microvisor Toolkit supports deployment of its two versions with Edge diff --git a/docs/developer-guide/get-started/building-howto.md b/docs/developer-guide/get-started/building-howto.md index c26214b486..0034004aac 100644 --- a/docs/developer-guide/get-started/building-howto.md +++ b/docs/developer-guide/get-started/building-howto.md @@ -123,6 +123,50 @@ Then, rebuild the image: sudo make image -j8 REBUILD_TOOLS=y REBUILD_PACKAGES=n CONFIG_FILE=./imageconfigs/edge-image.json ``` +### Update or Add Packages + +1. If a new package has to be released, follow these steps to ensure the package is available + in the artifactory: + + a. Checkout the tag for your agent which has to be released. + b. cd into your agent's directory. + c. Invoke `make tarball`. + d. Upload tarball from `build/artifacts` to the tarball repository. + +2. Update the respective .spec file in SPECS/`package` directory. Example: `SPECS/node-agent`. + +3. Bump the release number declared in the top section of the .spec file if on the same + version. Otherwise, update the release version and set the number to 1. + +4. Update `env_wrapper.sh` and the .spec file if there are installation changes or new + configurations to be added. + +5. Update the changelog to ensure the version and release number are mentioned correctly as + well. Example: + + ```bash + * Tue Mar 25 2025 Andrea Campanella - 1.5.11-2 + - Move from RSTYPE to RS_TYPE in wrapper for node-agent + ``` + +6. Generate sha256sum of all files that have been updated. +Example : `sha256sum ./SPECS/node-agent/env_wrapper.sh` + +7. Update the signature file name `.signatures.json`. Example: `node-agent.signatures.json`. + +8. Update `cgmanifest.json`. You can use a script to do it, if you have an RPM environment. + Otherwise, update the version and download the URL manually. Example commands to update + using a manifest: + + ```bash + python3 -m pip install -r ./toolkit/scripts/requirements.txt + python3 ./toolkit/scripts/update_cgmanifest.py first cgmanifest.json ./SPECS/node-agent/node-agent.spec + ``` + +> **Note:** + This guide applies to `rpm` package addition in general for Edge Microvisor. + ## Next - Learn how to [Enable Secure Boot for Edge Microvisor Toolkit](sb-howto.md). +- See the detailed description of how to [create a full build and customize it](/toolkit/docs/building/add-package.md).