-
Notifications
You must be signed in to change notification settings - Fork 76
OS tier levels + AutoSD as a community OS #2266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
|
2cb329f to
24804bd
Compare
|
The created documentation from the pull request is available at: docu-html |
d602c54 to
629cafa
Compare
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
629cafa to
eb1535e
Compare
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
…platform-onboarding Added descriptive texts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked the non-AutoSD-specific parts and I think this is a good starting point for adding OSs.
|
@odra whats the state with that pr? |
|
It's waiting for a review from the Arch. WG. |
qor-lb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR is a good step towards making “supported OSs / software platforms” discoverable and positioning Red Hat AutoSD as the first documented target platform. The new entry point under the OS module is useful and the AutoSD page already contains actionable technical information (build/run/tooling pointers), which aligns well with the intention that users find practical integration guidance in one place.
That said, to fully achieve the goal that users can quickly answer:
- What platforms are supported and at which level?
- How are the levels defined?
- How do I onboard / promote a new platform?
some restructuring and additional content would make the result significantly clearer and easier to maintain long-term imho.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should describes the onboarding, maybe something like this (in separate file):
.. _platform-onboarding:
Onboarding and Promotion of Platforms
=====================================
This page describes how platforms are added and promoted.
The process requirements are defined in :ref:`platform_assumptions`.
Principle
---------
Promotion has two phases:
1. **Eligibility (Platform Maintainer)**:
The platform maintainer resolves the **supplier** requirements of the target level.
Only if these requirements are fulfilled, the OS can be considered for promotion.
2. **Acceptance + Lifecycle Guarantees (S-CORE)**:
S-CORE reviews the promotion request.
If accepted at **Functional** or **Certifiable**, S-CORE commits to maintain the
guarantees of the accepted level across all increments.
Community level onboarding
--------------------------
**What it means**
In-tree best-effort integration.
S-CORE provides no guarantees.
**Eligibility requirements (Platform Maintainer / supplier requirements)**
The OS maintainer must fulfil the Community level supplier requirements as defined in:
:ref:`platform_assumptions`.
**Review and acceptance (S-CORE)**
S-CORE reviews the documentation entry for completeness and consistency.
Acceptance only means the platform is listed in-tree.
No infrastructure or lifecycle support is implied.
Promotion to Functional
-----------------------
**What it means**
S-CORE provides functional guarantees for the accepted reference integration and
maintains them across all increments.
**Eligibility requirements (Platform Maintainer / supplier requirements)**
The platform maintainer must fulfil the Functional level supplier requirements as defined in:
:ref:`platform_assumptions`.
**Additional acceptance requirements (S-CORE / system integrator requirements)**
From Functional level onwards, S-CORE must be able to continuously validate the platform.
This requires infrastructure and test integration.
**Required approvals**
Promotion to Functional requires explicit approval by:
* Platform maintainers
* Architecture WG
* Infrastructure WG (CI / build & test environment support)
* Testing WG
* Quality Management
Promotion to Certifiable
------------------------
**What it means**
S-CORE provides certifiability-oriented guarantees for the accepted reference integration
and maintains them across all increments.
**Eligibility requirements (Platform Maintainer / supplier requirements)**
The platform maintainer must fulfil the Certifiable level supplier requirements as defined in:
:ref:`platform_assumptions`.
**Additional acceptance requirements (S-CORE / system integrator requirements)**
Certifiable level implies additional safety/security expectations and evidence handling.
**Required approvals**
Promotion to Certifiable requires explicit approval by:
* OS module maintainers
* Architecture WG
* Infrastructure WG
* Testing WG
* Quality Management
* Safety Manager
* Security Manager
Demotion
--------
If the eligibility requirements or the S-CORE lifecycle guarantees of an accepted platform
can no longer be maintained, the platform must be demoted to the highest level that can be
sustained.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@odra this is still open
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added as onboarding.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a template that standardizes the information presented. I would also like the ability to filter for specific platform so making them as needs would be nice. Please include and link that in the onboarding page and apply it for autosd:
Platform Name
=============
.. platform:: <platform name>
:id: platform__<platform name snake case>
:level: <community/functinal/certifiable>
:maintainer: <GitHub Handles>
Short overview of the platform and why it is relevant for S-CORE.
Keep this to 3-6 lines. Mention what the OS is and the intended usage context.
Target maintainers/integration assistance
-----------------------------------------
GitHub Handles of the target maintainers.
Integration assistance
----------------------
- Provide the names or mailing lists that users can contact for help with S‑CORE integration.
- Use bullet points for multiple contacts.
Integration manual
------------------
- Summarise how to obtain and use the integration manual for this platform.
- Link to external documentation if it exists.
Build instructions
------------------
Explain how to build an image of this platform and how to build S-CORE for it.
.. code-block:: console
# example commands to build an image
curl -o /tmp/image-builder.sh https://example.com/image-builder.sh
chmod +x /tmp/image-builder.sh
sudo bash /tmp/image-builder.sh --distro <distro> --target <target>
Provide any additional context, such as how to boot or run the image (e.g. with QEMU).
Toolchain
---------
- Explain how to set up Bazel toolchains for this platform.
- Include a short example ``MODULE.bazel`` snippet.
Bug interface
-------------
- Explain how users can report bugs (mailing lists, issue trackers, Matrix/Slack channels etc.).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@odra this is still open. I would also link the template in the onboarding section above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added as "os_onboarding_template.rst"
|
we should also update the codeowner file to reflect the necessary approvals for the different levels |
aschemmel-tech
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see inline comments
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| .. _comp_doc_os_sw_platforms_community: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please rename this and the other occurrences to something different from "SW platform" because this is the name we use for the S-CORE SW platform - see discussion in #1740. I would rather call it plainly OS or Operating System. If you want to differentiate between different implementations maybe call it variant?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just kept it as "os", so the name structure is "comp_doc_os_$level_$osname" (_comp_doc_os__community__autosd)
| Community | ||
| ######### | ||
|
|
||
| These are the community-supported Software Platforms for Eclipse S-CORE. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better: "These are the Operating Systems supported on a "community" level for Eclipse S-CORE."
| ######### | ||
|
|
||
| These are the community-supported Software Platforms for Eclipse S-CORE. | ||
| See see :ref:`platform_assumptions` for the exact requirements for each Tier. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better: "for the exact requirements for each level (Tier)" as we do not use the term Tier in the assumptions.
|
|
||
| .. _comp_doc_os_sw_platforms: | ||
|
|
||
| Software Platforms |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also here please "Operating System" as a Component name. Or maybe "Operating System Platform" or "Operating System Environment" as proposed below in the text anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I replace the term by "Operating System"
|
|
||
| .. _comp_doc_os_sw_platforms_community: | ||
|
|
||
| Community |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please call this "Community Level"
| Integration Assistance | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. aou_req:: integration assistance |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please do not duplicate the AoU documented in the "SW-platform Assumptions" section of S-CORE. What you want is to document the "fulfillment" of these "Non-Functional" AoU with a instruction/guideline how to use "Red Hat AutoSD". So please refer here to the AoU by stating for example "The following fulfills :need:aou_req__platform__integration_assistance ". Better would be to describe the instruction/guideline as a sphinx needs element like @qor-lb proposed (but not with the id "platform__...") with an attribute that links to the AoU. But this is maybe a seperate PR because it would need considering the best way to change the metamodel and modelling by docs-as-code team.
| Integration Manual | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. aou_req:: integration manual |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see above
| Bug Interface | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| .. aou_req:: bug interface |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see above
Co-authored-by: Lars Bauhofer <lars.bauhofer@qorix.ai> Signed-off-by: Leonardo Rossetti <oss@lrossetti.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
|
@qor-lb @aschemmel-tech I've updated my PR with the requested changes, could you please review it again? |
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
opajonk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Details only
| ------------------- | ||
|
|
||
| Use the :doc:`onboarding template document <os_onboard_template>` as the starting point to add a new operating system to | ||
| one of the levels, as described in the previou sections of this document. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| one of the levels, as described in the previou sections of this document. | |
| one of the levels, as described in the previous sections of this document. |
| Short overview of the platform and why it is relevant for S-CORE. | ||
| Keep this to 3-6 lines. Mention what the OS is and the intended usage context. | ||
|
|
||
| Target maintainers/integration assistance |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again - title case or not? We should decide and then make it consistent.
Personally: Title Case +1, it looks more nice and is more common ;-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense to me, I've changed all headers to use title case
Co-authored-by: Oliver Pajonk <oliver@pjnk.de> Signed-off-by: Leonardo Rossetti <oss@lrossetti.com>
Co-authored-by: Oliver Pajonk <oliver@pjnk.de> Signed-off-by: Leonardo Rossetti <oss@lrossetti.com>
Signed-off-by: Leonardo Rossetti <lrossett@redhat.com>
| OS Name | ||
| ======= | ||
|
|
||
| .. os: <os_name> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our metamodel does not define that need, you should follow that, and OS is more or less a component, so use please .. comp: as defined here https://github.com/eclipse-score/docs-as-code/blob/main/src/extensions/score_metamodel/metamodel.yaml (row 553), example https://eclipse-score.github.io/score/main/modules/communication/ipc_binding/docs/architecture/index.html#comp__com_ipc_binding
if the intention here is only to have an description, then please use document (raw 202)
fixes #2264
Changes