-
Notifications
You must be signed in to change notification settings - Fork 61
Orchestration: Add feature templates and intial version of safety plan #1770
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
Open
PandaeDo
wants to merge
4
commits into
eclipse-score:main
Choose a base branch
from
qorix-group:vohae_safety_orchestration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
.. | ||
# ******************************************************************************* | ||
# Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
# | ||
# See the NOTICE file(s) distributed with this work for additional | ||
# information regarding copyright ownership. | ||
# | ||
# This program and the accompanying materials are made available under the | ||
# terms of the Apache License Version 2.0 which is available at | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# SPDX-License-Identifier: Apache-2.0 | ||
# ******************************************************************************* | ||
|
||
Feature Architecture | ||
==================== | ||
|
||
.. document:: Orchestration Architecture | ||
:id: doc__orchestration_architecture | ||
:status: draft | ||
:safety: ASIL_B | ||
:security: YES | ||
:realizes: PROCESS_wp__feature_arch | ||
:tags: orchestration | ||
|
||
|
||
Overview | ||
-------- | ||
Brief summary | ||
|
||
Description | ||
----------- | ||
|
||
General Description | ||
|
||
.. Design Decisions - For the documentation of the decision the :need:`PROCESS_gd_temp__change_decision_record` can be used. | ||
|
||
Design Constraints | ||
|
||
Requirements | ||
------------ | ||
|
||
.. code-block:: none | ||
|
||
.. needtable:: Overview of Feature Requirements | ||
:style: table | ||
:columns: title;id | ||
:filter: search("feat_arch_sta__archdes$", "fulfils_back") | ||
:colwidths: 70,30 | ||
|
||
|
||
Rationale Behind Architecture Decomposition | ||
******************************************* | ||
mandatory: a motivation for the decomposition | ||
|
||
.. note:: Common decisions across features / cross cutting concepts is at the high level. | ||
|
||
Static Architecture | ||
------------------- | ||
|
||
.. .. feat_arc_sta:: Static View | ||
.. :id: feat_arc_sta__orchestration__static_view | ||
.. :security: YES | ||
.. :safety: ASIL_B | ||
.. :status: invalid | ||
.. :fulfils: feat_req__orchestration__some_title | ||
.. :includes: logic_arc_int__orchestration__interface_name | ||
|
||
.. .. needarch:: | ||
.. :scale: 50 | ||
.. :align: center | ||
|
||
.. {{ draw_feature(need(), needs) }} | ||
|
||
Dynamic Architecture | ||
-------------------- | ||
|
||
.. .. feat_arc_dyn:: Dynamic View | ||
.. :id: feat_arc_dyn__orchestration__dynamic_view | ||
.. :security: YES | ||
.. :safety: ASIL_B | ||
.. :status: invalid | ||
.. :fulfils: feat_req__orchestration__some_title | ||
|
||
.. put here a sequence diagram | ||
|
||
Logical Interfaces | ||
------------------ | ||
|
||
.. .. logic_arc_int:: Interface Name | ||
.. :id: logic_arc_int__orchestration__interface_name | ||
.. :security: YES | ||
.. :safety: ASIL_B | ||
.. :status: invalid | ||
|
||
.. .. needarch:: | ||
.. :scale: 50 | ||
.. :align: center | ||
|
||
.. {{ draw_interface(need(), needs) }} | ||
|
||
.. .. logic_arc_int_op:: Operation | ||
.. :id: logic_arc_int_op__orchestration__operation | ||
.. :security: YES | ||
.. :safety: ASIL_B | ||
.. :status: invalid | ||
.. :included_by: logic_arc_int__orchestration__interface_name | ||
|
||
Module Viewpoint | ||
---------------- | ||
|
||
The following modules are needed to be defined to be able to draw the static feature view. | ||
They will be replaced by linking the proper module definitions in the used module's repositories as soon as those exist. | ||
|
||
.. .. mod_view_sta:: Module Name | ||
.. :id: mod_view_sta__orchestration__module_name | ||
.. :includes: comp_arc_sta__orchestration__component_name | ||
|
||
.. .. needarch:: | ||
.. :scale: 50 | ||
.. :align: center | ||
|
||
.. {{ draw_module(need(), needs) }} | ||
|
||
Used Components | ||
--------------- | ||
|
||
The following components are needed to be defined to be able to draw the static feature view. | ||
They will be replaced by linking the proper SW component definitions in the used module's repositories as soon as those exist. | ||
|
||
.. .. comp_arc_sta:: Component Name | ||
.. :id: comp_arc_sta__orchestration__component_name | ||
.. :safety: ASIL_B | ||
.. :security: YES | ||
.. :status: invalid | ||
.. :implements: logic_arc_int__orchestration__interface_name | ||
|
||
.. note:: | ||
Architecture can be split into multiple files, it is an High level architecture_design | ||
which can be shown without actual c++/rust interfaces and data types | ||
and there will be link to lower level architecture till code to get actual api descriptions. | ||
|
||
.. attention:: | ||
The above directives must be updated according to your feature architecture. | ||
|
||
- Replace the example content by the real content (according to :need:`PROCESS_gd_guidl__arch_design`) | ||
- Set the status to valid and start the review/merge process |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
.. | ||
# ******************************************************************************* | ||
# Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
# | ||
# See the NOTICE file(s) distributed with this work for additional | ||
# information regarding copyright ownership. | ||
# | ||
# This program and the accompanying materials are made available under the | ||
# terms of the Apache License Version 2.0 which is available at | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# SPDX-License-Identifier: Apache-2.0 | ||
# ******************************************************************************* | ||
|
||
|
||
DFA (Dependent Failure Analysis) | ||
================================ | ||
|
||
.. document:: Orchestration DFA | ||
:id: doc__orchestration_dfa | ||
:status: draft | ||
:safety: ASIL_B | ||
:security: YES | ||
:realizes: PROCESS_wp__feature_dfa | ||
:tags: orchestration | ||
|
||
|
||
Dependent Failure Initiators | ||
---------------------------- | ||
|
||
.. code-block:: rst | ||
|
||
.. feat_saf_dfa:: <Title> | ||
:violates: <Feature architecture> | ||
:id: feat_saf_dfa__<Feature>__<Element descriptor> | ||
:failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`> | ||
:failure_effect: "description of failure effect of the failure initiator on the element" | ||
:mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement> | ||
:mitigation_issue: <ID from Issue Tracker> | ||
:sufficient: <yes|no> | ||
:status: <valid|invalid> | ||
|
||
.. note:: argument is inside the 'content'. Therefore content is mandatory | ||
|
||
.. attention:: | ||
The above directive must be updated according to your feature DFA. | ||
|
||
- The above "code-block" directive must be updated | ||
- Fill in all the needed information in the <brackets> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
.. | ||
# ******************************************************************************* | ||
# Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
# | ||
# See the NOTICE file(s) distributed with this work for additional | ||
# information regarding copyright ownership. | ||
# | ||
# This program and the accompanying materials are made available under the | ||
# terms of the Apache License Version 2.0 which is available at | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# SPDX-License-Identifier: Apache-2.0 | ||
# ******************************************************************************* | ||
|
||
|
||
FMEA (Failure Modes and Effects Analysis) | ||
========================================= | ||
|
||
.. document:: Orchestration FMEA | ||
:id: doc__orchestration_fmea | ||
:status: draft | ||
:safety: ASIL_B | ||
:security: YES | ||
:realizes: PROCESS_wp__feature_fmea | ||
:tags: orchestration | ||
|
||
|
||
Failure Mode List | ||
----------------- | ||
|
||
.. code-block:: rst | ||
|
||
|
||
.. feat_saf_fmea:: <Title> | ||
:violates: <Feature architecture> | ||
:id: feat_saf_fmea__<Feature>__<Element descriptor> | ||
:fault_id: <ID from fault model :need:`gd_guidl__fault_models`> | ||
:failure_effect: "description of failure effect of the fault model on the element" | ||
:mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement> | ||
:mitigation_issue: <ID from Issue Tracker> | ||
:sufficient: <yes|no> | ||
:status: <valid|invalid> | ||
|
||
.. note:: argument is inside the 'content'. Therefore content is mandatory | ||
|
||
.. attention:: | ||
The above directive must be updated according to your feature FMEA. | ||
|
||
- The above "code-block" directive must be updated | ||
- Fill in all the needed information in the <brackets> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
@PandaeDo , It seems that this page is rendering with the old Eclipse webpage color
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.
just rebase, then you have the latest color scheme