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
6 changes: 5 additions & 1 deletion examples/demo_verification/test_examples.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,11 @@ def test_examples(target, setup_test, remote_test_dir):
lmcontrol_path = str(remote_test_dir / "lmcontrol")

_step("Starting launch manager (Startup)")
lm_proc = target.execute_async(lm_path, cwd=str(remote_test_dir))
lm_proc = target.execute_async(
lm_path,
args=["-c", "etc/lifecycle_demo_test_gen.bin"],
cwd=str(remote_test_dir),
)

time.sleep(1.0)
assert lm_proc.is_running(), "Launch manager exited unexpectedly during Startup"
Expand Down
77 changes: 77 additions & 0 deletions score/launch_manager/docs/user_guide/getting_started.rst
Comment thread
NicolasFussberger marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
..
# *******************************************************************************
# Copyright (c) 2026 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
# *******************************************************************************

Getting Started
###############

This guide walks through creating a minimal Launch Manager configuration and running the
daemon for the first time.

Configuration
*************

The Launch Manager reads its configuration from a FlatBuffers binary file. When building
with Bazel, the ``launch_manager_config`` rule handles the conversion from a human-readable
JSON file to the binary format automatically.

Bazel Build Rule
================

Add a ``launch_manager_config`` target to your ``BUILD`` file:

.. code-block:: starlark

load("//:defs.bzl", "launch_manager_config")

launch_manager_config(
name = "my_config",
config = ":my_config.json",
flatbuffer_out_dir = "etc",
)

Write a Configuration File
==========================

Create a JSON configuration file that describes the components to launch, the run targets,
and the alive supervision settings.

.. dropdown:: Example configuration (lifecycle_demo_test.json)

.. literalinclude:: ../../../../examples/demo_verification/lifecycle_demo_test.json
:language: json

For a full description of all available fields see :doc:`configuration`.

Running the Launch Manager
**************************

Start the daemon by pointing it at the generated FlatBuffers binary with the ``-c`` option:

.. code-block:: bash

launch_manager -c etc/my_config_gen.bin

Command-line Options
====================

.. code-block:: text

Usage: launch_manager [-c <config>] [-h]

Options:
-c <config> Path to the flatbuffer config binary.
Default: etc/launch_manager_config_gen.bin
-h Print this help and exit.

Passing an unknown option prints the usage line and exits with a non-zero exit code.
1 change: 1 addition & 0 deletions score/launch_manager/docs/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ User Guide

.. toctree::

getting_started.rst
concepts.rst
ready_state.rst
configuration.rst
Expand Down
1 change: 1 addition & 0 deletions score/launch_manager/src/daemon/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ cc_binary(
deps = [
"//score/launch_manager/src/daemon/src/alive_monitor",
"//score/launch_manager/src/daemon/src/common:log",
"//score/launch_manager/src/daemon/src/configuration:flatbuffer_config_loader",
"//score/launch_manager/src/daemon/src/osal:ipc_comms",
"//score/launch_manager/src/daemon/src/process_group_manager",
"//score/launch_manager/src/daemon/src/process_group_manager:alive_monitor_thread",
Expand Down
25 changes: 0 additions & 25 deletions score/launch_manager/src/daemon/src/alive_monitor/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,6 @@
# *******************************************************************************
load("@rules_cc//cc:defs.bzl", "cc_library")

filegroup(
name = "am_flatcfg_fbs",
srcs = ["config/hm_flatcfg.fbs"],
visibility = ["//visibility:public"],
)

filegroup(
name = "am_core_flatcfg_fbs",
srcs = ["config/hmcore_flatcfg.fbs"],
visibility = ["//visibility:public"],
)

exports_files(["config/hm_flatcfg.fbs"])

cc_library(
name = "config",
hdrs = [
"config/hm_flatcfg_generated.h",
"config/hmcore_flatcfg_generated.h",
],
include_prefix = "score/mw/launch_manager/alive_monitor",
strip_include_prefix = "/score/launch_manager/src/daemon/src/alive_monitor",
visibility = ["//score/launch_manager/src/daemon/src/alive_monitor:__subpackages__"],
)

cc_library(
name = "alive_monitor",
visibility = ["//score:__subpackages__"],
Expand Down

This file was deleted.

Loading
Loading