Skip to content

Commit

Permalink
Merge pull request #6 from mF2C/ALEJANDROJ19-patch-1
Browse files Browse the repository at this point in the history
Policies instructions added
  • Loading branch information
Cristovao Cordeiro committed May 31, 2018
2 parents 9309e42 + 00e1d1a commit 55f080c
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions documentation/developer_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ Installing the mF2C System
Installing a Leader
~~~~~~~~~~~~~~~~~~~

**Prerequisites for the policies module:**

One of the responsibilities of this module is to provide the execution of the strategy for the Leader Failure, by selecting a backup. The static list of allowed devices to become a backup by the user must be provided before executing the agent. You should modify the `.env` file adding the topology like the following line:

.. code-block:: txt
TOPOLOGY=[(123,'192.168.5.2'),(456,'192.168.5.4')]
Here, you should provide for each allowed backup, an integer to identify internally the agent and the IP address, each device surrounded with parenthesis and the IP address with single quoting. An empty topology forces the Leader to not select any backup.

*This configuration can be applied to a regular agent aswell. If the agent becomes a leader due a leader failure, the provided topology is used to select the new backup*

**Prerequisites for the discovery module:**

A device with a wireless card that supports "master mode" (i.e. that can act as an access point). You can check whether your card supports master mode by running the following command, looking for the "Supported interface modes". You should find "AP" in the list (i.e. Master mode) :
Expand All @@ -37,6 +49,19 @@ As far as the discovery module is concerned, this script grabs the name of the w
Installing a regular agent
~~~~~~~~~~~~~~~~~~~~~~~~~~

**Prerequisites for the policies module:**

If the agent becomes a leader due a leader failure, the provided topology is used to select the new backup.

One of the responsibilities of this module is to provide the execution of the strategy for the Leader Failure, by selecting a backup. The static list of allowed devices to become a backup by the user must be provided before executing the agent. You should modify the `.env` file adding the topology like the following line:

.. code-block:: txt
TOPOLOGY=[(123,'192.168.5.2'),(456,'192.168.5.4')]
Here, you should provide for each allowed backup, an integer to identify internally the agent and the IP address, each device surrounded with parenthesis and the IP address with single quoting. An empty topology forces the Leader to not select any backup.


.. code-block:: bash
./mf2c-deployment.sh
Expand Down

0 comments on commit 55f080c

Please sign in to comment.