Skip to content

Commit

Permalink
small improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Steiner <robert@flower.ai>
  • Loading branch information
Robert-Steiner committed Jul 26, 2024
1 parent 4fe7a6e commit 3771a89
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 20 deletions.
11 changes: 1 addition & 10 deletions doc/source/contributor-how-to-build-docker-images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,22 +104,13 @@ Building the SuperLink/SuperNode or ServerApp image
- Yes
- :substitution-code:`|stable_flwr_version|-py3.11-ubuntu|ubuntu_version|`

The following command creates either a SuperLink, SuperNode or ServerApp image with the official Flower
base image:

.. code-block:: bash
$ cd src/docker/<superlink|supernode|serverapp>/
$ docker build \
--build-arg BASE_IMAGE=<FLOWER-VERSION>-py<PY-VERSION>-<DISTRIBUTION and VERSION> \
-t flwr_superlink:0.1.0 .
For example, to build a SuperLink image with the latest Flower version, Python 3.11 and Ubuntu 22.04, run the following:

.. code-block:: bash
:substitutions:
$ cd src/docker/superlink
$ docker build \
$ docker build \
--build-arg BASE_IMAGE=|current_flwr_version|-py3.10-ubuntu22.04 \
-t flwr_superlink:0.1.0 .
Expand Down
20 changes: 10 additions & 10 deletions doc/source/docker/tutorial-quickstart-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@ Step 5: Run the Quickstart Project
$ docker logs -f superexec
Step 6: Update the Application Code
-----------------------------------
Step 6: Update the Application
------------------------------

#. Change the application code. For example, change the ``seed`` in ``quickstart_docker/task.py``
to ``43`` and save it:
Expand Down Expand Up @@ -350,17 +350,17 @@ Step 6: Update the Application Code
Step 7: Clean Up
----------------

#. Remove the containers and the bridge network:
Remove the containers and the bridge network:

.. code-block:: bash
.. code-block:: bash
$ docker stop $(docker ps -a -q --filter ancestor=flwr_supernode:0.0.1) \
superexec \
superlink
$ docker network rm flwr-network
$ docker stop $(docker ps -a -q --filter ancestor=flwr_supernode:0.0.1) \
superexec \
superlink
$ docker network rm flwr-network
Where to Go Next
----------------

* :doc:`Enabling TLS for secure connections <tls>`
* :doc:`Persist the state of the SuperLink <persist-superlink-state>`
* :doc:`tls`
* :doc:`persist-superlink-state`

0 comments on commit 3771a89

Please sign in to comment.