Skip to content

Commit 2b42e45

Browse files
authored
Rephrasing documentation.
1 parent f47d3bc commit 2b42e45

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation/polycubed/polycubed.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ If the same parameter is specified in both, the configuration file and the comma
5959
Persistency
6060
^^^^^^^^^^^
6161

62-
To add stateful capabilities and improve its reliability, polycubed has some functionalities that allow the user to recover from failures without losing data.
63-
By default, while running the daemon keeps in memory an instance of all the topology, that is updated each time the user modifies it.
64-
To avoid loss of data, after every change the cubes configuration is dumped to file too. The default path is ``/etc/polycube/cubes.yaml``.
65-
The standard behavior of the daemon at startup is to load the latest topology that have been dumped in that file the previous time.
66-
It is possible to define a different topology file by using the ``--cubes-dump`` flag followed by the path to the file.
67-
In the case we want to start polycubed with an empty topology, avoiding any possible load at startup, we can add the ``--cubes-init`` flag.
68-
Beware of the fact that any previous configuration in the file will be overwritten after the first modification.
69-
If not necessary, it is also possible to disable this functionality by using the ``--cubes-nodump`` flag and we would avoid any penalty it could produce.
62+
Polycubed has persistent capabilities, which means that (1) it can automatically load the configuration that was present when the daemon was shut down, (2) each time a configuration command is issued, it is automatically dumped on disk.
63+
This enables polycubed also to recover from failures, such as rebooting the machine.
64+
By default, the daemon keeps in memory an instance of all the topology, including the configuration of each individual service.
65+
Topology and configuration are automatically updated at each new command; the configuration is also dumped to disk, on file ``/etc/polycube/cubes.yaml``.
66+
The standard behavior of the daemon at startup is to load the latest topology that was active at the end of the previous execution.
67+
Users can load a different topology file by using the ``--cubes-dump`` flag followed by the path to the file.
68+
In case we want to start polycubed with an empty topology, avoiding any possible load at startup, we can launch polycubed with the ``--cubes-init`` flag. Beware that in this case any existing configuration in the default file will be overwritten.
69+
Finally, persistency can be disabled with the ``--cubes-nodump`` flag; this would also avoid any (very limited) performance penalty introduced by this feature.
7070

7171
::
7272

@@ -84,4 +84,4 @@ If not necessary, it is also possible to disable this functionality by using the
8484
Rest API
8585
^^^^^^^^
8686

87-
TODO...
87+
TODO...

0 commit comments

Comments
 (0)