-
Notifications
You must be signed in to change notification settings - Fork 36
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.
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
Docs/SK-691 | Add tutorial for distributed deployment #530
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work. However, I was more envisaging a more detailed step-by-step tutorial showing how to configure a RPI4 with FEDn and starting it as a client, probably connecting it to an existing FEDn deploy and FEDn Studio.
So I think it will be more pedagogical to split in two:
|
Sounds good! I will fix that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I suggest that you highlight that this is not a secure deployment (unless the users takes separate measures) and that you refer to FEDn Studio for a production-grade deployment.
docs/distributed.rst
Outdated
------------- | ||
|
||
|
||
Note the local IP address of your host device; it will be needed later. Follow the standard procedure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better here to replicate how you start up the server-side? Suggest the user to use docker-compose? Also mention where to find the ports they need to open?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggested docker-compose and added where to find the ports in the note.
|
||
.. code-block:: | ||
|
||
<host local ip> api-server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be public ip, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is mainly for deployment over local networks, so the host's local network IP. I've clarified that and referred to Studio for secure deployment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it is a distributed setup you cannot communicate on the hosts local IP from a client. I think the setting that all machines are on the same local network is fairly uncommon.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I see, you made that clear in the beginning of the tutorial.
|
||
.. code-block:: | ||
|
||
<host local ip> api-server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I see, you made that clear in the beginning of the tutorial.
Adds a tutorial to the docs for distributed deployment.