Skip to content
This repository was archived by the owner on Jun 29, 2026. It is now read-only.

[DOCS] Restructure EIM documentation#390

Open
sgolebiewski-intel wants to merge 3 commits into
open-edge-platform:mainfrom
sgolebiewski-intel:restructure-docs
Open

[DOCS] Restructure EIM documentation#390
sgolebiewski-intel wants to merge 3 commits into
open-edge-platform:mainfrom
sgolebiewski-intel:restructure-docs

Conversation

@sgolebiewski-intel

Copy link
Copy Markdown
Contributor

PR Description

The proposed changes are part of the effort to target modular decomposition of Edge Infrastructure Manager, described in ticket: 79416 and 84758. Changes include:

  • creating a section for EIM components (providing new content from respective infra repositories)
  • removing duplicated content in the overview.rst, hl_architecture, background.rst files, moving remaining content to the index file.
  • reorganizing menu structure
  • updating references

Changes

List the changes you have made.

Additional Information

Include any additional information, such as how to test your changes.

Checklist

  • Tests passed
  • Documentation updated

The split into the Host and Instance resources expresses the split into the
Onboarding and Provisioning phases - the Onboarding phase ends when the Host
resource enters its desired state ``ONBOARDED``, while the Provisioning phase
ends when the Instance resource achieves the ``RUNNING`` state.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

onboard manager is also acts as a host resource manager responsible to update onboarding status and provisioning status but HostStatus to Running set by node agent by calling hostResource manager's grpc call - https://github.com/open-edge-platform/infra-managers/tree/main/host#edge-infrastructure-host-resource-manager

@sgolebiewski-intel sgolebiewski-intel Feb 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provided an update with: 451670d

scottmbaker
scottmbaker previously approved these changes Feb 27, 2026

@scottmbaker scottmbaker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the overall restructuring. I left a few minor comments that could be addressed earlier. As a high-level point, I think we still have a few levels of indirection between the EIM top page and the components. I have to navigate EIM -> Architecture -> Components -> [a specific component]. I wonder if there's opportunity to collapse one or more of those levels. For example, we could introduce the components at the top level.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While reading through the docs, I found this statement hard to interpret, and it's high up in our list of features. Could we better summarize the 50 edge device concurrent onboarding (prior bullet) together with concurrent 10,000 edge devices and 1000 edge devices for OS provisioning?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated with: 43e0611

Comment thread docs/developer_guide/infra_manager/index.rst Outdated
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants