[node-patches] Change in ovirt-node[master]: tui: Add some more docs

[fabiand at fedoraproject.org]

Fabian Deutsch has uploaded a new change for review.

Change subject: tui: Add some more docs
......................................................................

tui: Add some more docs

Change-Id: I515d2c24efcb47b2e7361ed47f675b2b60d4ac76
Signed-off-by: Fabian Deutsch <fabiand at fedoraproject.org>
---
M scripts/tui/README
A scripts/tui/src/ovirt/node/CONCEPT
2 files changed, 29 insertions(+), 1 deletion(-)


  git pull ssh://gerrit.ovirt.org:29418/ovirt-node refs/changes/83/10883/1

diff --git a/scripts/tui/README b/scripts/tui/README
index f2ff3e5..76b055d 100644
--- a/scripts/tui/README
+++ b/scripts/tui/README
@@ -1,7 +1,12 @@
 A simple system to build a TUI (based on urwid) by plugins.
 
 $ sudo yum install python python-urwid
-$ PYTHONPATH=src ./bin/ovirt-config-setup-molch
+
+# Don't execute any transaction and assume that defaults is in /tmp/cfg_dummy:
+$ PYTHONPATH=./src bash bin/ovirt-config-setup --defaults /tmp/cfg_dummy --dry
+
+# Real-World execution
+$ PYTHONPATH=./src bash bin/ovirt-config-setup
 
 
 Features
diff --git a/scripts/tui/src/ovirt/node/CONCEPT b/scripts/tui/src/ovirt/node/CONCEPT
new file mode 100644
index 0000000..89da80e
--- /dev/null
+++ b/scripts/tui/src/ovirt/node/CONCEPT
@@ -0,0 +1,23 @@
+
+"Node Central" - How configuration changes are applied
+------------------------------------------------------
+The overall concept of the setup is to take UI data to update the
+/etc/default/ovirt file (through the classes in config/defaults.py) and to
+apply these changes using transactions (which can be retrieved using the
+transaction() methods).
+
+
+Paths
+-----
+
+config: This folder contains modules related to config files
+        E.g. the configured IPv4 Address, NTP server ...
+config/defaults.py: This module can be used to modify /etc/default/ovirt
+config/network.py: This module can be used to modify resolv.conf/ntp.conf ...
+
+utils: This folder contains classes which don't modify config files but provide
+       runtime-informations (e.g. current ip, storage devices)
+
+setup: Page-Plugins for the setup
+
+installer: Page-Plugins for the installer
\ No newline at end of file


--
To view, visit http://gerrit.ovirt.org/10883
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I515d2c24efcb47b2e7361ed47f675b2b60d4ac76
Gerrit-PatchSet: 1
Gerrit-Project: ovirt-node
Gerrit-Branch: master
Gerrit-Owner: Fabian Deutsch <fabiand at fedoraproject.org>