Skip to content
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

Merged
merged 9 commits into from
Mar 20, 2024

Conversation

viktorvaladi
Copy link
Contributor

@viktorvaladi viktorvaladi commented Feb 16, 2024

Adds a tutorial to the docs for distributed deployment.

@Wrede Wrede changed the title Docs/sk 691 | Add tutorial for distributed deployment on Raspberry Pi's Docs/SK-691 | Add tutorial for distributed deployment on Raspberry Pi's Feb 16, 2024
@ahellander ahellander self-requested a review March 2, 2024 07:26
Copy link
Member

@ahellander ahellander left a 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.

@ahellander
Copy link
Member

So I think it will be more pedagogical to split in two:

  1. Distributed deployment (docs)
  2. Example / tutorial with Rasberry PI5.

@viktorvaladi
Copy link
Contributor Author

So I think it will be more pedagogical to split in two:

  1. Distributed deployment (docs)
  2. Example / tutorial with Rasberry PI5.

Sounds good! I will fix that.

@viktorvaladi viktorvaladi changed the title Docs/SK-691 | Add tutorial for distributed deployment on Raspberry Pi's Docs/SK-691 | Add tutorial for distributed deployment Mar 15, 2024
@viktorvaladi viktorvaladi requested a review from ahellander March 15, 2024 15:19
Copy link
Member

@ahellander ahellander left a 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.

-------------


Note the local IP address of your host device; it will be needed later. Follow the standard procedure
Copy link
Member

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?

Copy link
Contributor Author

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
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Member

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.

@viktorvaladi viktorvaladi requested a review from ahellander March 19, 2024 11:13

.. code-block::

<host local ip> api-server
Copy link
Member

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.

@viktorvaladi viktorvaladi merged commit 656df02 into master Mar 20, 2024
15 checks passed
@viktorvaladi viktorvaladi deleted the docs/SK-691 branch March 20, 2024 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants