First and incomplete try for list of supported flags

1 files changed, 55 insertions, 0 deletions

diff --git a/doc/FLAGS b/doc/FLAGS
new file mode 100644
index 0000000..ce45f79
--- /dev/null
+++ b/doc/FLAGS
@@ -0,0 +1,55 @@
+This file describes all flags you can use as dependencies in plugins.
+The general structure of flag name is category_subsystem_part_lowerpart_...
+For every level of the hierarchy should exist FlagTrackerPlugin which byl set the master flags, when everything is OK.
+
+experimental
+  Flag denoting plugin as experimental and not to be run except in testing environment and by advanced users.
+  Do not provide in any plugin! Dependency flag only!
+
+unsafe
+  This plugin works, but can cause damage when the planets are badly aligned. Run only if you know what are you doing.
+  Do not providein any plugin! Dependency flag only!
+
+storage
+  All storage related tests ran with Not applicable or OK results
+
+storage_lvm
+  LVM is present and OK
+
+storage_md
+  MD is present and OK
+
+storage_<filesystem name>
+  All filesystems of this type are OK
+
+storage_layout
+  Direstory structure of installed box is OK
+
+boot
+  All tests for bootable box ran with Not applicable or OK results
+
+boot_grub
+boot_lilo
+  Bootloader is present and OK
+
+boot_kernel
+boot_initrd
+  The booting kernel/initrd pair is present and OK
+
+boot_kernel_modules
+  All checked modules are present and OK
+
+boot_kernel_modules_<modulename>
+  Module is present and supposed to work
+
+network
+  All network related tests ran with Not applicable or OK results
+
+network_link
+network_hostname
+network_hosts
+network_dhcp
+network_dns
+network_firewall
+  Part of network configuration was checked and appears OK
+