Skip to content

Commit

Permalink
clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
viktorvaladi committed Mar 19, 2024
1 parent cecc892 commit 91cfbfd
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/distributed.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
Distributed Deployment
===================================

This tutorial outlines the steps for deploying the FEDn framework on a local network, using a workstation as
This tutorial outlines the steps for deploying the FEDn framework over a **local network**, using a workstation as
the host and different devices as clients. For general steps on how to run FEDn, see one of the quickstart tutorials.


.. note::
For deployment over a public network, ensure you have:
For a secure and production-grade deployment solution over **public networks**, explore the FEDn studio service at
**studio.scaleoutsystems.com**.

- A public IP address
- Forwarded the necessary ports
- Implemented necessary security precautions

Then, follow these steps but substitute the local IP address with your public IP.
Alternatively follow this tutorial substituting the hosts local IP with your public IP, open the neccesary
ports (see which ports are used in docker-compose.yaml), and ensure you have taken additional neccesary security
precautions.

Prerequisites
-------------
Expand All @@ -25,16 +24,18 @@ Launch a distributed FEDn Network
-------------


Note the local IP address of your host device; it will be needed later. Follow the standard procedure
to initiate a FEDn network. Once the network is active, upload your compute package and seed (for comprehensive details,
see the quickstart tutorials).
Start by noting your host's local IP address, used within your network. Discover it by running ifconfig on UNIX or
ipconfig on Windows, typically listed under inet for Unix and IPv4 for Windows.

Continue with following the standard procedure to initiate a FEDn network, for example using by docker-compose.
Once the network is active, upload your compute package and seed (for comprehensive details, see the quickstart tutorials).


Configuring and Attaching Clients
-------------

On your client device, continue with initializing your client. To connect to the host machine we need to ensure we are
routing the correct DNS to our hosts local IP adress. We can do this using the standard FEDn `client.yaml`:
routing the correct DNS to our hosts local IP address. We can do this using the standard FEDn `client.yaml`:

.. code-block::
Expand All @@ -43,11 +44,13 @@ routing the correct DNS to our hosts local IP adress. We can do this using the s
discover_port: 8092
We can then run using docker by adding the hosts to the docker run command:
We can then run using docker by adding the hosts in the docker run command:

.. code-block::
docker run \
-v $PWD/client.yaml:<client.yaml file location> \
<potentiel data pointers>
—add-host=api-server:<host local ip> \
—add-host=combiner:<host local ip> \
<image name> run client -in client.yaml --name client1
Expand Down

0 comments on commit 91cfbfd

Please sign in to comment.