+
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ use_repo(python)

# Additional Python rules provided by aspect, e.g. an improved version of
# `py_binary`. But more importantly, it provides `py_venv`.
bazel_dep(name = "aspect_rules_py", version = "1.4.0")
bazel_dep(name = "aspect_rules_py", version = "1.6.3")

###############################################################################
#
Expand Down
147 changes: 147 additions & 0 deletions docs/features/orchestration/architecture/index.rst

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

Copy link
Contributor

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

just rebase, then you have the latest color scheme

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
9 changes: 7 additions & 2 deletions docs/features/orchestration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,19 @@ Orchestration
:id: doc__orchestration
:status: valid
:safety: ASIL_B
:realizes:
:security: YES
:realizes: PROCESS_wp__feat_request
:tags: feature_request, change_management, orchestration


.. toctree::
:hidden:

requirements.rst
requirements/index.rst
architecture/index.rst
safety_planning/index.rst
safety_analysis/fmea.rst
safety_analysis/dfa.rst


Feature flag
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,16 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************


Requirements
#############

.. evaluate following sth requirements:
.. com driven:
.. stkh_req__app_architectures__support_time
.. stkh_req__app_architectures__support_data
.. stkh_req__app_architectures__support_request
.. stkh_req__communication__service_quality

.. compute driven:
.. stkh_req__execution_model__processes
.. stkh_req__dev_experience__tracing_of_exec

.. safety:
.. stkh_req__dependability__automotive_safety
.. stkh_req__functional_req__safe_comput

.. security:
.. stkh_req__dependability__security_features

.. accelerators:
.. stkh_req__functional_req__hardware_comput
.. stkh_req__functional_req__comp_subsystem
############

.. document:: Orchestration Requirements
:id: doc__orchestration_requirements
:status: valid
:safety: ASIL_B
:security: YES
:realizes: PROCESS_wp__requirements_feat
:tags: orchestration


Executor
Expand Down Expand Up @@ -381,3 +365,6 @@ General Constraints
:status: invalid

The system shall use the approved IPC feature exclusively for all inter-process synchronization.

.. needextend:: docname is not None and "orchestration/requirements" in docname
:+tags: orchestration
49 changes: 49 additions & 0 deletions docs/features/orchestration/safety_analysis/dfa.rst
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>
50 changes: 50 additions & 0 deletions docs/features/orchestration/safety_analysis/fmea.rst
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>
Loading
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载