Schema documentation by SimonKozik · Pull Request #114 · eclipse-score/lifecycle

SimonKozik · 2026-03-11T15:21:53Z

This pull request followup on #88 and provide documentation for JSON schema.

Part of #38

github-actions · 2026-03-11T15:22:50Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.4.2) and connecting to it...
INFO: Invocation ID: c4a3445d-8c69-4552-8f82-82b43772267e
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_rust_policies', the root module requires module version score_rust_policies@0.0.3, but got score_rust_policies@0.0.5 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (52 packages loaded, 9 targets configured)

Analyzing: target //:license-check (89 packages loaded, 9 targets configured)

Analyzing: target //:license-check (145 packages loaded, 2642 targets configured)

Analyzing: target //:license-check (153 packages loaded, 5687 targets configured)

Analyzing: target //:license-check (160 packages loaded, 7852 targets configured)

Analyzing: target //:license-check (165 packages loaded, 7901 targets configured)

Analyzing: target //:license-check (166 packages loaded, 8025 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 10039 targets configured).
[3 / 14] checking cached actions
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 26.577s, Critical Path: 2.63s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-03-11T15:26:12Z

The created documentation from the pull request is available at: docu-html

src/launch_manager_daemon/config/config_schema/docs/images/example_conf_graph.png

MaciejKaszynski

looks good

paulquiring

Very concise and detailed. One comment: I feel that someone without prior knowledge of this topic would need a bit more information. I left a proposal in the comments.

paulquiring · 2026-03-16T08:49:05Z

src/launch_manager_daemon/config/config_schema/docs/launch_manager_configuration.rst

+A single component might be deployed across several different systems. To facilitate this, the specific deployment configuration (how and where a component runs) is intentionally kept separate from the inherent properties of the component itself. This separation promotes flexibility and reusability.
+
+.. _lm_conf_run_targets_grouping_and_components_activation:
+Run Targets: Grouping and Components Activation


I get the feeling that someone with no prior knowledge of this topic would need a little more information.

Just adding one more paragraph and moving around the paragraphs, would help.

Run Targets: Grouping and Components Activation -> Run Targets: Modelling the system
Explain active, (un)assigned

Right after "When the Launch Manager Starts a Component" you could move "Run Targets: Grouping and Components Activation" as is.

Changes applied, finger cross it reads better now and is more understandable.

NicolasFussberger · 2026-03-17T09:08:22Z

src/launch_manager_daemon/config/config_schema/default_values/watchdog_defaults.json

@@ -0,0 +1,8 @@
+{
+    "watchdog": {


I think we should not by default configure this watchdog.
For /dev/watchdog to be available you require a resource manager / kernel driver that sets this up.
If we have this as default configured, users will likely stumble upon this as LaunchManager will not startup because the /dev/watchdog is not available

As per discussion earlier, possibility to disable watchdog is now added.

NicolasFussberger · 2026-03-17T13:44:21Z

src/launch_manager_daemon/config/config_schema/default_values/deployment_config_defaults.json

+        },
+        "recovery_action": {
+            "switch_run_target": {
+                "run_target": "Off"


Should this be fallback_run_target?

Should be resolved now

NicolasFussberger · 2026-03-17T13:59:49Z

src/launch_manager_daemon/config/config_schema/docs/launch_manager_configuration.rst

+
+The S-CORE standard provides the following default values for ``watchdog`` properties if they are not explicitly defined elsewhere:
+
+.. code-block:: json


I would recommend to have the default values either here or to include the files from the default_values folder, but I would like to avoid having the same information in two locations.

NicolasFussberger · 2026-03-17T14:04:04Z

src/launch_manager_daemon/config/config_schema/docs/launch_manager_configuration.rst

@@ -0,0 +1,596 @@
+..


Could we please integrate this into the lifecycle documentation build?

NicolasFussberger · 2026-03-23T12:39:12Z

Please consider this comment from @pawelrutkaq #110 (comment)

lets remove s-core from name. makse no sens imho. and it even wors with - and _ mixup

NicolasFussberger · 2026-03-23T12:47:41Z

src/launch_manager_daemon/config/config_schema/docs/launch_manager_configuration.rst

+
+**Properties:**
+
+* **device_file_path** (string, optional)


It looks like most of the properties text is copy/paste from the description that is already in the schema file.
If anyone changes the schema file, they may forget to update this copy or vice versa.
Therefore, I would prefer to avoid duplication.
I would recommend to either simply refer to the schema file and only adding additional information here or including sections of the schema if that is possible (e.g. using rst include)

pawelrutkaq · 2026-03-25T09:34:51Z

src/launch_manager_daemon/config/config_schema/docs/images/example_conf_graph.svg

Please save drawio fiel as drawio.svg so you have single file displayed as svg and also metadata

SimonKozik requested a deployment to workflow-approval March 11, 2026 15:21 — with GitHub Actions Waiting

SimonKozik mentioned this pull request Mar 11, 2026

Configuration description for Launch Manager #54

Closed

MaciejKaszynski suggested changes Mar 13, 2026

View reviewed changes

src/launch_manager_daemon/config/config_schema/docs/images/example_conf_graph.png Outdated Show resolved Hide resolved

SimonKozik temporarily deployed to workflow-approval March 13, 2026 14:23 — with GitHub Actions Inactive

SimonKozik temporarily deployed to workflow-approval March 13, 2026 14:51 — with GitHub Actions Inactive

MaciejKaszynski approved these changes Mar 13, 2026

View reviewed changes

paulquiring approved these changes Mar 16, 2026

View reviewed changes

anmittag added this to LCM - Lifecycle & Health FT Mar 16, 2026

github-project-automation bot moved this to Backlog in LCM - Lifecycle & Health FT Mar 16, 2026

SimonKozik requested a deployment to workflow-approval March 17, 2026 08:01 — with GitHub Actions Waiting

SimonKozik requested a deployment to workflow-approval March 17, 2026 08:27 — with GitHub Actions Waiting

NicolasFussberger reviewed Mar 17, 2026

View reviewed changes

NicolasFussberger requested changes Mar 17, 2026

View reviewed changes

SimonKozik requested a deployment to workflow-approval March 23, 2026 11:50 — with GitHub Actions Waiting

SimonKozik requested a deployment to workflow-approval March 23, 2026 12:16 — with GitHub Actions Waiting

NicolasFussberger reviewed Mar 23, 2026

View reviewed changes

SimonKozik requested a deployment to workflow-approval March 23, 2026 14:39 — with GitHub Actions Waiting

SimonKozik requested a deployment to workflow-approval March 24, 2026 08:56 — with GitHub Actions Waiting

SimonKozik requested a deployment to workflow-approval March 24, 2026 09:04 — with GitHub Actions Waiting

SimonKozik added 20 commits March 24, 2026 09:27

First version of of documentation

020f040

Fixing lists rendering

50f14bb

Fixing remaining problems with lists rendering

72634c3

Adding default values provided by S-CORE standard

c4fd068

Adding description of examples

6779bf0

Attempting to fix image path

3c4d66c

Trying to fix problem where image is not displayed

7e40afb

Updating readme file with info about things added in this PR

71482ef

Cosmetic changes

33d0814

Adding information about unconfigured fallback_run_target

d2281ab

Adding links between documents

857828f

Changing file format for pictures, as per review comment

2eb7e56

Adding reference labels for each section

80c6dda

Fixing spelling mistake in default values

35d1a33

Updating default values to match schema documentation

49752c7

Updating default recovery action, as per review comment

941fc09

Adding possibility to disable watchdog, as per review comment

ca146f4

Adding extra clarification and rearranging text, as per review comment

596e517

Renaming schema file as per review comment

c7449c0

Fixing usage of the old schema name after branch rebase

8f6e598

SimonKozik force-pushed the feature/schema_documentation branch from 37b8657 to 8f6e598 Compare March 24, 2026 09:33

SimonKozik requested a deployment to workflow-approval March 24, 2026 09:33 — with GitHub Actions Waiting

Fixing old value in the documentation

dcf306a

SimonKozik requested a deployment to workflow-approval March 24, 2026 12:26 — with GitHub Actions Waiting

pawelrutkaq reviewed Mar 25, 2026

View reviewed changes


		The S-CORE standard provides the following default values for ``watchdog`` properties if they are not explicitly defined elsewhere:

		.. code-block:: json

Conversation

SimonKozik commented Mar 11, 2026

Uh oh!

github-actions bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions bot commented Mar 11, 2026

Uh oh!

Uh oh!

MaciejKaszynski left a comment

Choose a reason for hiding this comment

Uh oh!

paulquiring left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NicolasFussberger commented Mar 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions bot commented Mar 11, 2026 •

edited

Loading