Skip to content

Update docs to reflect compiling a RTI for each federation. #309

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 16, 2025
Merged

Update docs to reflect compiling a RTI for each federation. #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09f7f1b
Update docs to reflect compiling a RTI for each federation.
erlingrj Apr 15, 2025
7d4ccf0
Address code-review
erlingrj Apr 16, 2025
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
9 changes: 0 additions & 9 deletions docs/reference/security.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,6 @@ target C {
};
```

The RTI build must include CMake options to enable simple HMAC-based authentication of federates. Add `-DAUTH=ON` option to the CMake command as shown below:

```bash
mkdir build && cd build
cmake -DAUTH=ON ../
make
sudo make install
```

If you would like to go back to non-AUTH mode, you would have to remove all contents of the `build` folder.

</ShowOnly>
71 changes: 13 additions & 58 deletions docs/writing-reactors/distributed-execution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,6 @@ In addition to the federates, there is a program called the **RTI**, for **runti
It is possible to encapsulate federates in Docker containers for deployment.
See [containerized execution](../reference/docker-support.mdx).

## Installation of the RTI

Federated execution requires installation of a separate stand-alone program called the Runtime Infrastructure or **RTI**. At the current time, the only way to install this is from source files:

```shell
git clone https://github.com/lf-lang/reactor-c.git
cd reactor-c/core/federated/RTI/
mkdir build && cd build
cmake ../
make
sudo make install
```

The above will create a program called `RTI` and install it at `/usr/local/bin/RTI`. Once this program is available in your path, you can compile and execute federated Lingua Franca programs using [VS Code or the command-line tools](/docs/installation). For more details, see the [README file](https://github.com/lf-lang/reactor-c/blob/main/core/federated/RTI/README.md).

## Minimal Example

A minimal federated execution is specified by using the `federated` keyword instead of `main` for the main federate. An example is given below:
Expand All @@ -55,21 +40,13 @@ When you run the code generator on `src/Federated.lf` containing the above code,


<ShowIfs>
<ShowIf c>

```
bin/Federated
bin/Federated_s
bin/Federated_d
```

</ShowIf>
<ShowIf py>
<ShowIf c py>

```
bin/Federated
src-gen/Federated/s/Federated_s.py
src-gen/Federated/d/Federated_d.py
fed-gen/Federated/bin/federated__s
fed-gen/Federated/bin/federated__d
fed-gen/Federated/bin/RTI
```

</ShowIf>
Expand All @@ -86,26 +63,16 @@ When you run the code generator on `src/Federated.lf` containing the above code,

The root name, `Federated`, is the name of the .lf file from which these are generated (and the name of the main reactor, which is required to match if it is specified). The suffixes "\_s" and "\_d" come from the names of the top-level instances. There will always be one federate for each top-level reactor instance.

To run the program, you can simply run `bin/Federated`, which is a `bash` script that launches the RTI and two other programs, `Federated_s` and `Federated_d`.
To run the program, you can simply run `bin/Federated`, which is a `bash` script that launches the RTI and two other programs, `federated__s` and `federated__d`.
Alternatively, you can manually execute the RTI followed by the two federate programs by starting them on the command line. It is best to use three separate terminal windows (so that outputs from the three programs do not get jumbled together) to execute the following commands:

<ShowIfs>
<ShowIf c>
<ShowIf c py>

```sh
RTI -n 2
bin/Federated_s
bin/Federated_d
```

</ShowIf>

<ShowIf py>

```sh
RTI -n 2
python3 src-gen/Federated/s/Federated_s.py
python3 src-gen/Federated/d/Federated_d.py
fed-gen/Federated/bin/RTI -n 2
fed-gen/Federated/bin/federated__s
fed-gen/Federated/bin/federated__d
```

</ShowIf>
Expand Down Expand Up @@ -149,22 +116,12 @@ Upon running the program, you will see information printed about the starting an

You may have several federations running on the same machine(s) or even several instances of the same federation. In this case, it is necessary to distinguish between the federations. To accomplish this, you can pass a `-i` or `--id` parameter to the RTI and its federates with an identifier that is unique to the particular federation. For example,
<ShowIfs>
<ShowIf c>
<ShowIf c py>

```sh
RTI -n 2 -i myFederation
bin/Federated_s -i myFederation
bin/Federated_d -i myFederation
```

</ShowIf>

<ShowIf py>

```sh
RTI -n 2 -i myFederation
python3 src-gen/Federated/s/Federated_s.py -i myFederation
python3 src-gen/Federated/d/Federated_d.py -i myFederation
fed-gen/Federated/bin/RTI -n 2 -i myFederation
fed-gen/Federated/bin/federated__s -i myFederation
fed-gen/Federated/bin/federated__d -i myFederation
```

</ShowIf>
Expand Down Expand Up @@ -318,8 +275,6 @@ Enable means to always start the service at startup, whereas start means to just

It will also be much more convenient if the launcher does not have to enter passwords to gain access to the remote machine. This can be accomplished by installing your public key (typically found in `~/.ssh/id_rsa.pub`) in `~/.ssh/authorized_keys` on the remote host.

Second, the RTI must be installed on the remote machine. See [instructions for installation the RTI](#installation-of-the-rti).

## Specifying RTI Hosts

You can specify a domain name on which the RTI should run as follows:
Expand Down
Loading