From 63a451cd935f142f10a2d5adcca3675307cc342d Mon Sep 17 00:00:00 2001
From: Saad Zaher <saad.zaher@hpe.com>
Date: Tue, 8 Mar 2016 12:11:26 +0000
Subject: [PATCH] Updating README and HACKING files for oslo options

Updating REAMDME and HACKING to allow users to generate sample
config files if needed.

Change-Id: I388271f80d6fc89bbdf20522e9280445a6cbf43a
---
 HACKING.rst | 34 ++++++++++++++++++++++++++++++++++
 README.rst  | 22 ++++++++++++++++++++++
 2 files changed, 56 insertions(+)

diff --git a/HACKING.rst b/HACKING.rst
index b8ccb568..aed525a3 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -20,3 +20,37 @@ Use the common logging module, and ensure you ``getLogger``::
 
     LOG.debug('Foobar')
 
+
+oslo.config
+-----------
+
+- All configuration options for freezer-scheduler should be in the following file ::
+
+    freezer/scheduler/arguments.py
+
+- After adding new options to freezer-scheduler please use the following command to update the sample configuration file::
+
+    oslo-config-generator --config-file config-generator/scheduler.conf
+
+- If you added support for a new oslo library, you have to edit the following file adding a new namespace for the new oslo library:
+for example adding oslo.db::
+
+    # edit config-generator/scheduler.conf
+    [DEFAULT]
+    output_file = etc/scheduler.conf.sample
+    wrap_width = 79
+    namespace = scheduler
+    namespace = oslo.log
+    namespace = oslo.db
+
+This will add oslo.db options to your configuration file.
+
+Agent Options
+-------------
+- All configuration options for freezer-agent should be in the following file ::
+
+    freezer/common/config.py
+
+- To list options available in freezer-agent use the following command::
+
+    oslo-config-generator --namespace freezer --namespace oslo.log
diff --git a/README.rst b/README.rst
index 015b6e56..229226fe 100644
--- a/README.rst
+++ b/README.rst
@@ -987,3 +987,25 @@ optional arguments:
                         Remote username for ssh storage only
   --ssh-host SSH_HOST   Remote host for ssh storage only
   --ssh-port SSH_PORT   Remote port for ssh storage only (default 22)
+
+
+Scheduler Options
+-----------------
+
+To get an updated sample of freezer-scheduler configuration you the following command::
+
+    oslo-config-generator --config-file config-generator/scheduler.conf
+
+you will find the update sample file in etc/scheduler.conf.sample
+
+Agent Options
+-------------
+
+To list options available in freezer-agent use the following command::
+
+    oslo-config-generator --namespace freezer --namespace oslo.log
+
+this will print all options to the screen you direct the output to a file if you want::
+
+    oslo-config-generator --namespace freezer --namespace oslo.log --output-file etc/agent.conf.sample
+