adding variables system_app_root and system_config_directory

README.md

@@ -22,68 +22,90 @@ User defined variables
 Variables
 ---------
 
-- system_home_mirror:
-  - description:
-    - URL of the producer's package repository
-  - hint: This variable is set by each system.
-
-- system_local_mirror:
-  - description:
-    - URL of the local package repository
-
-- system_mirror_directory:
-  - description:
-    - path to the root mirror directory on system for all system
-  - hint: This variable is set by function role.
-
-- system_supported_architures:
-  - description:
-    - list of system architectures supported by the system role; needed for installer und mirror
-  - hint: This variable is set by each system.
-
-- system_supported_releases:
-  - description:
-    - list of system releases supported by the system role; needed for installer und mirror
-  - hint: This variable is set by each system.
-
-- system_container_base_config:
-  - description:
-    - path to the base configuration file for containers
-  - hint: default file is provided by this system role
-
-- system_container_root: 
-  - description:
-    - path to the root directory for each jail 
-  - hint: default file is provided by this system role
-
-- system_suppress_container_creation:
-  - description:
-    - If this option is set to true, the system will be prepared for container usage, but none will be installed.
-  - choises: [true, false]
-  - default: false
-
-- system_installer_path:
-  - description:
-    - destination path to the directory for the installer
-
-- system_answer_path:
-  - description:
-    - destination path to the directory for the answer file
-
-- system_name:
-  - description:
-    - contains the distribution name of a system; needed for gatherpackages
-
-- system_gathered_packages:
-  - description:
-    - list of all packages; result of gatherpackages 
-
-- system_upgrade_states:
-  - description:
-    - a dictionary with the results of upgrade (see features)
-
-Tasks
-=====
+* system_home_mirror:
+  * description:
+    * URL of the producer's package repository
+  * hint: This variable is set by each system.
+
+* system_local_mirror:
+  * description:
+    * URL of the local package repository
+
+* system_mirror_directory:
+  * description:
+    * path to the root mirror directory on system for all system
+  * hint: This variable is set by function role.
+
+* system_supported_architures:
+  * description:
+    * list of system architectures supported by the system role; needed for installer und mirror
+  * hint: This variable is set by each system.
+
+* system_supported_releases:
+  * description:
+    * list of system releases supported by the system role; needed for installer und mirror
+  * hint: This variable is set by each system.
+
+* system_container_base_config:
+  * description:
+    * path to the base configuration file for containers
+  * hint: default file is provided by this system role
+
+* system_container_root: 
+  * description:
+    * path to the root directory for each jail 
+  * hint: default file is provided by this system role
+
+* system_suppress_container_creation:
+  * description:
+    * If this option is set to true, the system will be prepared for container usage, but none will be installed.
+  * choises: [true, false]
+  * default: false
+
+* system_installer_path:
+  * description:
+    * destination path to the directory for the installer
+
+* system_answer_path:
+  * description:
+    * destination path to the directory for the answer file
+
+* system_name:
+  * description:
+    * contains the distribution name of a system; needed for gatherpackages
+
+* system_gathered_packages:
+  * description:
+    * list of all packages; result of gatherpackages 
+
+* system_upgrade_states:
+  * description:
+    * a dictionary with the results of upgrade (see features)
+
+* system_app_root:
+  * description:
+    * contains the general path for applications with final path separator
+    * must be set in defaults/main.yml of each system role 
+  * examples:
+    * Linux: system_app_root: "/"
+    * FreeBSD: system_app_root: "/usr/local/"
+    * OpenBSD: system_app_root: "/usr/local/"
+    * NetBSD: system_app_root: "/usr/pkg/"
+  * default: undefined
+
+* system_config_directory:
+  * description:
+    * contains the general path for configuration files of applications with final path separator
+    * must be set in defaults/main.yml of each system role 
+  * examples:
+    * Linux: system_app_root: "/etc/"
+    * FreeBSD: system_app_root: "/usr/local/etc/"
+    * OpenBSD: system_app_root: "/etc/"
+    * NetBSD: system_app_root: "/usr/pkg/etc/"
+  * default: undefined
+  
+Processes
+=========
 
 main
 ----
@@ -100,47 +122,6 @@ configure
 4. append groups to users, if defined
 5. set timezone
 
-upgrade
--------
-
-1. NOP
-
-createcontainer
----------------
-
-1. NOP
-
-registercontainer
------------------
-
-1. NOP
-
-mirror
-------
-
-1. NOP
-
-installer
----------
-
-1. NOP
-
-answerfile
-----------
-
-1. NOP
-
-gatherpackages
---------------
-
-1. iterate over all roles and execute _loadpkgvars
-
-_loadpkgvars
-------------
-
-1. load default/main.yml of every role
-2. add content of package_packages to system_gathered_packages
-
 Features
 ========