docs:monitor: Configuration content outline
Fill in the fan monitor JSON configuration content and add syntax
detail markdown files for each attribute available. Each attribute's
syntax markdown file will be completed in follow-up commits to provide
further details on the attribute within the configuration.
Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Ibe97080c8b993c67c54af9989e775191607314b7
diff --git a/docs/monitor/README.md b/docs/monitor/README.md
index acd3015..51cda9e 100644
--- a/docs/monitor/README.md
+++ b/docs/monitor/README.md
@@ -109,16 +109,103 @@
### Structure
-TBD
+The config file consists of an array of fan objects that define how to monitor
+their functional state and what fault handling should occur. Fault handling
+includes creating error logs and/or powering off the system for a configured
+number of fans that are missing or nonfunctional.
+```
+{
+ "fans": [
+ {
+ ...
+ },
+ .
+ .
+ .
+ ],
+ "sensor_trust_groups": [
+ {
+ ...
+ },
+ .
+ .
+ .
+ ],
+ "fault_handling": {
+ ...
+ }
+}
+```
### Syntax
-TBD
+Fan object attributes: **(Required unless otherwise noted)**
+* [inventory](inventory.md)
+* [method](method.md) - *Optional, default = "timebased"
+ * "timebased":
+ * [allowed_out_of_range_time](allowed_out_of_range_time.md)
+ * [functional_delay](functional_delay.md) - Optional, default = 0
+* [deviation](deviation.md)
+* [num_sensors_nonfunc_for_fan_nonfunc](num_sensors_nonfunc_for_fan_nonfunc.md) - Optional, default = 0
+* [monitor_start_delay](monitor_start_delay.md) - Optional, default = 0
+* [fan_missing_error_delay](fan_missing_error_delay.md) - Optional
+* [nonfunc_rotor_error_delay](nonfunc_rotor_error_delay.md) - Optional
+* [sensors](sensors.md)
+
+Trust group attributes: **(Optional)**
+* [class](class.md)
+* [group](group.md)
+
+Fault handling attributes: **(Optional)**
+* [num_nonfunc_rotors_before_error](num_nonfunc_rotors_before_error.md) -
+Optional, default = 1
+* [power_off_config](power_off_config.md) - Optional
+
+*-See attribute page for more details
### Comments
-TBD
+The JSON data format does not support comments. However, an optional `comments`
+attribute name can be used to annotate any specific entry of the JSON
+configuration. It is suggested that the value of this `comments` attribute be
+an array of strings for comments containing line breaks. All `comments` objects
+are ignored when the JSON configuration is processed.
+***Note: Only 1 `comments` object can exist at any given 'layer' of the
+configuration hierarchy***
+
+Example:
+```
+{
+ "comments": [
+ "Fan monitoring configuration of X-number of fans",
+ "Where some fan sensors are not trusted at times",
+ "Faults create error logs and power off the system"
+ ],
+ "fans": [
+ {
+ "comments": "Monitor this fan",
+ ...
+ },
+ .
+ .
+ .
+ ],
+ "sensor_trust_groups": [
+ {
+ "comments": "Only trust these fan sensors when all are not zero",
+ ...
+ },
+ .
+ .
+ .
+ ],
+ "fault_handling": {
+ "comments": "Log errors and power off the system",
+ ...
+ }
+}
+```
## Validation
diff --git a/docs/monitor/class.md b/docs/monitor/class.md
new file mode 100644
index 0000000..32fe3e9
--- /dev/null
+++ b/docs/monitor/class.md
@@ -0,0 +1,9 @@
+# class
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/deviation.md b/docs/monitor/deviation.md
new file mode 100644
index 0000000..14ae09e
--- /dev/null
+++ b/docs/monitor/deviation.md
@@ -0,0 +1,9 @@
+# deviation
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/fan_missing_error_delay.md b/docs/monitor/fan_missing_error_delay.md
new file mode 100644
index 0000000..e5447fc
--- /dev/null
+++ b/docs/monitor/fan_missing_error_delay.md
@@ -0,0 +1,9 @@
+# fan_missing_error_delay
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/group.md b/docs/monitor/group.md
new file mode 100644
index 0000000..8a6ca2c
--- /dev/null
+++ b/docs/monitor/group.md
@@ -0,0 +1,9 @@
+# group
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/inventory.md b/docs/monitor/inventory.md
new file mode 100644
index 0000000..d5cfb7f
--- /dev/null
+++ b/docs/monitor/inventory.md
@@ -0,0 +1,9 @@
+# inventory
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/method.md b/docs/monitor/method.md
new file mode 100644
index 0000000..28e9a23
--- /dev/null
+++ b/docs/monitor/method.md
@@ -0,0 +1,9 @@
+# method
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/monitor_start_delay.md b/docs/monitor/monitor_start_delay.md
new file mode 100644
index 0000000..2a72006
--- /dev/null
+++ b/docs/monitor/monitor_start_delay.md
@@ -0,0 +1,9 @@
+# monitor_start_delay
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/nonfunc_rotor_error_delay.md b/docs/monitor/nonfunc_rotor_error_delay.md
new file mode 100644
index 0000000..a9c13ef
--- /dev/null
+++ b/docs/monitor/nonfunc_rotor_error_delay.md
@@ -0,0 +1,9 @@
+# nonfunc_rotor_error_delay
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/num_nonfunc_rotors_before_error.md b/docs/monitor/num_nonfunc_rotors_before_error.md
new file mode 100644
index 0000000..efaf9d2
--- /dev/null
+++ b/docs/monitor/num_nonfunc_rotors_before_error.md
@@ -0,0 +1,9 @@
+# num_nonfunc_rotors_before_error
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
new file mode 100644
index 0000000..ea473e2
--- /dev/null
+++ b/docs/monitor/num_sensors_nonfunc_for_fan_nonfunc.md
@@ -0,0 +1,9 @@
+# num_sensors_nonfunc_for_fan_nonfunc
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/power_off_config.md b/docs/monitor/power_off_config.md
new file mode 100644
index 0000000..9ae40d7
--- /dev/null
+++ b/docs/monitor/power_off_config.md
@@ -0,0 +1,9 @@
+# power_off_config
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example
diff --git a/docs/monitor/sensors.md b/docs/monitor/sensors.md
new file mode 100644
index 0000000..e5341fb
--- /dev/null
+++ b/docs/monitor/sensors.md
@@ -0,0 +1,9 @@
+# sensors
+
+## Description
+
+
+## Attribute Value(s)
+
+
+## Example