Docs updates

This commit is contained in:
Zaid Abdulla committed 2019-08-13 23:55:50 -07:00
1 parent 78eec1b5ca
commit 46e009afab
4 files changed
+39

No files matched your search

+28
View File
@@ -0,0 +1,28 @@
.. _administration-faq:
Administration FAQ
==================
.. topic:: Duplicate log entries when using log() function
Because GenieACS uses a full fledged scripting language for device
configuration, the only way to guarantee that it has satisfied the 'desired
state' is by repeatedly executing the script until there's no more
discrepancies with the current device state. Though it may seem like this
will cause duplicate requests going to the device, this isn't actually the
case because device configuration are stated declaratively and that the
scripts themselves are pure functions in the context of a session (e.g.
Date.now() always returns the same value within the session).
To illustrate further, consider following script:
.. code:: javascript
declare("Device.param", null, {value: 1});
commit();
declare("Device.param", null, {value: 2});
This will set the value of the 'Device.param' to 1, then to 2. Then as the
script is run again the value is set back to 1 and so on. A stable state will
never be reached so GenieACS will execute the script a few times until it
gives up and throws a fault.
+9
View File
@@ -415,6 +415,15 @@ parameterValues key. For example:
-X POST \
--data '{"name":"addObject","objectName":"InternetGatewayDevice.WANDevice.1.WANConnectionDevice.1.WANPPPConnection"}'
``deleteObject``
~~~~~~~~~~~~~~~~
.. code:: bash
curl -i 'http://localhost:7557/devices/00236a-SR552n-SR552NA084%252D0003269/tasks?timeout=3000&connection_request' \
-X POST \
--data '{"name":"deleteObject","objectName":"InternetGatewayDevice.WANDevice.1.WANConnectionDevice.1.WANPPPConnection.1"}'
``reboot``
~~~~~~~~~~
+1
View File
@@ -30,6 +30,7 @@ Welcome to GenieACS's documentation!
provisions
virtual-parameters
administration-faq
.. raw:: latex
+1
View File
@@ -73,6 +73,7 @@ Configure systemd
GENIEACS_FS_ACCESS_LOG_FILE=/var/log/genieacs/genieacs-fs-access.log
GENIEACS_UI_ACCESS_LOG_FILE=/var/log/genieacs/genieacs-ui-access.log
GENIEACS_DEBUG_FILE=/var/log/genieacs/genieacs-debug.yaml
GENIEACS_EXT_DIR=/opt/genieacs/ext
GENIEACS_UI_JWT_SECRET=secret
Set file ownership and permissions: