Uses pandoc to convert the manpage into a markdown document and add it
to the mkdocs documentation.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
This adds a function to decode JSON configuration via Jansson to the
router agent. The JSON functionality and, thus, the dependency on
Jansson, can be disabled during the build process by setting the
`DISABLE_JSON` compile-time flag (see `config.mk.example` for details).
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
- Add `make doc` target to run protoc-gen-doc before mkdocs
- Ignore auto generated markdown files
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
In order to adjust the resulting markdown files to our needs, the
upstream markdown template[^1] is added. The markdown template itself is
added to exclude_docs in the mkdocs.yaml file.
[^1]: https://github.com/pseudomuto/protoc-gen-doc/blob/master/resources/markdown.tmpl
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com
This moves most of the extended instructions to the mkDocs pages. The
intention is to keep the bare minimum in the README for developers that
just want to quickly try it out.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This adds a page explaining the use of the Python module to build an AAP
2.0 client and links it from the corresponding page.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This adds a page to the web documentation that provides a high-level
overview of µD3TN's architecture. The existing architecture figure is
updated and renamed appropriately.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This moves the 'build_plantuml.sh' file to the 'image-material' directory, and takes on a more generic approach for the CSS changes.
Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com>
This performs the following actions:
- change overall documentation tree to adjust to existing material
- add CSS for improved visuals
- add folders to improve structure
- move the README of the Contact Plan Reader to the doc folder and integrate it into the documentation
- add file for 'Home' to provide a starting point for the documentation
Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com>
Adds a MkDocs configuration and directory, as well as a Nix derivation
for creating HTML files. Since we do not want to add the MkDocs
documentation to the overlay, `self` is passed to `shell.nix` to inherit
the inputs from the packages.
The inline code documentation is added to the MkDocs HTML output using
the plugins `mkdoxy` for C code and `mkdocstrings` for Python code.
Adds an job to the CI to build and deploy the documentation at
https://d3tn.gitlab.io/ud3tn/.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
As AAP does not provide TLS support, a user exposing it on a TCP socket
should know what they are doing and set up appropriate firewall rules.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This allows for using AAP 2.0 over TCP, which the Python tools support
already. Note that the user must make sure that the socket is not
exposed externally.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
We did not really explain how to deal with node restarts beforehand.
This adds some hints to the quick start guide and the SQLite CLA docs.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
We do not render it with `pandoc` automatically and it looks like an
artifact in GitLab. In the rendered version it is not really necessary
as well -- in our case it means just that the heading will receive a
number which is OK in my opinion.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
- document implemented fragmentation and storage features for AAP 2.0
- add AAP 2.0 interactions to quick start guide
- update Manpage, README, and testing docs accordingly
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This was confusing users. We are adding a detailed explanation in the
man page and informing in the help text that the parameter refers to the
administrative endpoint of uD3TN.
Fixes: #213
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
The field is not used anymore as we do dropped support for probabilistic
routing, which was a very primitive prototype, anyways. The contact
parser only supports the field for compatibility reasons and drops it in
case it is present. Thus, we should not document it here.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
After merging !184, the description of how the storage can be accessed
when using the integrated routing agent must be moved to the
corresponding subsection.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
This makes µD3TN behave the same as v0.13.0 when executed without an
additional commandline argument. A new commandline argument `-d` /
`--external-dispatch` is added, which enables the use of external BDMs.
The default forwarding implementation is now again provided using the
v0.13 code, extracted from e1621765a4 and
adapted to the new agent-based forwarding implementation.
Central changes to the old code include:
- A new "Routing Agent" that handles incoming configuration commands,
FIB updates, and BDM dispatch requests.
- The use of the BDM authorization flag to authorize contact
configuration commands.
- The Contact Manager now only triggers the creation and removal of
links / FIB entries; bundle dispatch is triggered through the FIB and
BDM callback functions of the Routing Agent.
- The fragmentation logic is adapted to store the original bundle along
with an offset and length value, instead of pre-creating and storing
the fragments.
- The bundle re-scheduling logic integrated into the Routing Agent is
simplified and does not support changing the fragmentation parameters.
A new function is added to the Router that searches for a new route
for such fragments that were already scheduled at some point,
considering them as un-fragmentable bundle with overridden fragment
offset and length.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This also fixes the CLA address specified with `aap2-config` - it has to
contain a colon at the end.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
- Replace a), b) enumeration with 1., 2. because this was not displayed
correctly by Gitlab
- Fix figure link to `aap20-seq_link_dispatch.svg`
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
Changes all occurrences of the old script paths from tools/ to the
scripts installed by python-ud3tn-utils.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
