Document config
diff --git a/xos/observers/helloworldservice/helloworldservice_config b/xos/observers/helloworldservice/helloworldservice_config
index 86a7dba..9afe406 100644
--- a/xos/observers/helloworldservice/helloworldservice_config
+++ b/xos/observers/helloworldservice/helloworldservice_config
@@ -1,7 +1,9 @@
+# Required by XOS
[plc]
name=plc
deployment=plc
+# Required by XOS
[db]
name=xos
user=postgres
@@ -9,6 +11,7 @@
host=localhost
port=5432
+# Required by XOS
[api]
host=localhost
port=8000
@@ -21,13 +24,27 @@
nova_enabled=True
logfile=/var/log/xos.log
+# Sets options for the observer
[observer]
+# Optional name
name=helloworldservice
+# This is the location to the dependency graph you generate
dependency_graph=/opt/xos/observers/helloworldservice/model-deps
+# The location of your SyncSteps
steps_dir=/opt/xos/observers/helloworldservice/steps
+# A temporary directory that will be used by ansible
sys_dir=/opt/xos/observers/helloworldservice/sys
+# Location of the file to save logging messages to the backend log is often used
logfile=/var/log/xos_backend.log
+# If this option is true, then nothing will change, we simply pretend to run
pretend=False
+# If this is False then XOS will use an exponential backoff with the observer
+# fails, since we will be waiting for an instnace, we don't want this.
backoff_disabled=True
+# We want to output from ansible to be logged
save_ansible_output=True
+# This determines how we SSH to a client, if this is set to True then we try
+# to ssh using the instance name as a proxy, if this is disabled we ssh using
+# the NAT IP of the instance. On CloudLab the first option will fail so we must
+# set this to False
proxy_ssh=False