Simplified the configuration file using defaults.

Previously to create a subsystem the admin would have to copy the
entire default deployment configuration, which contains many
parameters, and then customize it. Now the deployment code has been
changed such that the default config file will be used to provide
the default values, so the admin will only need to provide the
non-default parameters, thus reducing the size of the file.

Sample configuration files are provided in /usr/share/pki/
deployment/config.

Ticket #399

7 files changed, 26 insertions, 18 deletions

diff --git a/base/deploy/CMakeLists.txt b/base/deploy/CMakeLists.txt
index 9838b0343..26abe5346 100644
--- a/base/deploy/CMakeLists.txt
+++ b/base/deploy/CMakeLists.txt
@@ -56,15 +56,10 @@ install(
 )
 
 install(
-    FILES
-        config/pkideployment.cfg
-        config/pkislots.cfg
+    DIRECTORY
+        config
     DESTINATION
-        ${DATA_INSTALL_DIR}/deployment/config
-    PERMISSIONS
-        OWNER_WRITE OWNER_READ
-        GROUP_READ
-        WORLD_READ
+        ${DATA_INSTALL_DIR}/deployment
 )
 
 find_package(PythonInterp REQUIRED)
diff --git a/base/deploy/config/pkideployment.cfg b/base/deploy/config/deployment.cfg
index 133d4e993..133d4e993 100644
--- a/base/deploy/config/pkideployment.cfg
+++ b/base/deploy/config/deployment.cfg
diff --git a/base/deploy/config/sample.cfg b/base/deploy/config/sample.cfg
new file mode 100644
index 000000000..6e9530334
--- /dev/null
+++ b/base/deploy/config/sample.cfg
@@ -0,0 +1,6 @@
+[Common]
+pki_admin_password=
+pki_backup_password=
+pki_client_pkcs12_password=
+pki_ds_password=
+pki_security_domain_password=
diff --git a/base/deploy/src/scriptlets/infrastructure_layout.py b/base/deploy/src/scriptlets/infrastructure_layout.py
index 31c788bfd..ee405f2c1 100644
--- a/base/deploy/src/scriptlets/infrastructure_layout.py
+++ b/base/deploy/src/scriptlets/infrastructure_layout.py
@@ -40,7 +40,7 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                             extra=config.PKI_INDENTATION_LEVEL_1)
         # NOTE:  It was determined that since the "pkidestroy" command
         #        relies upon a symbolic link to a replica of the original
-        #        "pkideployment.cfg" configuration file used by the
+        #        deployment configuration file used by the
         #        "pkispawn" command of an instance, it is necessary to
         #        create any required instance and subsystem directories
         #        in this top-level "infrastructure_layout" scriptlet
@@ -50,7 +50,7 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
         #
         # establish the top-level infrastructure, instance, and subsystem
         # registry directories for storage of a copy of the original
-        # "pkideployment.cfg" configuration file used to spawn this instance,
+        # deployment configuration file used to spawn this instance,
         # and save a copy of this file
         util.directory.create(master['pki_registry_path'])
         util.directory.create(master['pki_instance_type_registry_path'])
diff --git a/base/deploy/src/scriptlets/pkiconfig.py b/base/deploy/src/scriptlets/pkiconfig.py
index 7e426b0f9..ab3cebb67 100644
--- a/base/deploy/src/scriptlets/pkiconfig.py
+++ b/base/deploy/src/scriptlets/pkiconfig.py
@@ -99,9 +99,14 @@ PKI_DEPLOYMENT_DEFAULT_APACHE_SERVICE_NAME = "apache"
 PKI_DEPLOYMENT_DEFAULT_TOMCAT_SERVICE_NAME = "tomcat"
 PKI_DEPLOYMENT_DEFAULT_APACHE_INSTANCE_NAME = "pki-apache"
 PKI_DEPLOYMENT_DEFAULT_TOMCAT_INSTANCE_NAME = "pki-tomcat"
-PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE = "pkideployment.cfg"
+
+PKI_DEPLOYMENT_CONFIGURATION_DIR =\
+    "/usr/share/pki/deployment/config"
+PKI_DEPLOYMENT_CONFIGURATION_FILE = "deployment.cfg"
+PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE =\
+    PKI_DEPLOYMENT_CONFIGURATION_DIR + "/" + PKI_DEPLOYMENT_CONFIGURATION_FILE
 PKI_DEPLOYMENT_SLOTS_CONFIGURATION_FILE =\
-    "/usr/share/pki/deployment/config/pkislots.cfg"
+    PKI_DEPLOYMENT_CONFIGURATION_DIR + "/pkislots.cfg"
 
 # subtypes of PKI subsystems
 PKI_DEPLOYMENT_CLONED_PKI_SUBSYSTEM = "Cloned"
@@ -151,7 +156,7 @@ def str2bool(string):
 #        and 'wait_to_attach_an_external_java_debugger(master)' functions,
 #        change 'pki_enable_java_debugger=False' to
 #        'pki_enable_java_debugger=True' in the appropriate
-#        'pkideployment.cfg' configuration file.
+#        deployment configuration file.
 def prepare_for_an_external_java_debugger(instance):
     print
     print PKI_DEPLOYMENT_INTERRUPT_BANNER
diff --git a/base/deploy/src/scriptlets/pkimessages.py b/base/deploy/src/scriptlets/pkimessages.py
index 99647946c..09ad0cfc7 100644
--- a/base/deploy/src/scriptlets/pkimessages.py
+++ b/base/deploy/src/scriptlets/pkimessages.py
@@ -114,7 +114,7 @@ PKIDESTROY_EPILOG =\
 "REMINDER:\n\n"\
 "    The default PKI instance path will be calculated and placed in front\n"\
 "    of the mandatory '-i <instance>' parameter, and the values that reside\n"\
-"    in a copy of the 'pkideployment.cfg' file that was most recently used\n"\
+"    in deployment configuration file that was most recently used\n"\
 "    by this instance's 'pkispawn' (or 'pkispawn -u') command will be\n"\
 "    utilized by 'pkidestroy' to remove this instance.\n\n"\
 "    Finally, if an optional '-p <prefix>' is defined, this value WILL be\n"\
diff --git a/base/deploy/src/scriptlets/pkiparser.py b/base/deploy/src/scriptlets/pkiparser.py
index 0d811af6e..6103ce9e5 100644
--- a/base/deploy/src/scriptlets/pkiparser.py
+++ b/base/deploy/src/scriptlets/pkiparser.py
@@ -171,7 +171,7 @@ class PKIConfigParser:
                 deployed_pki_subsystem_path + "/" +\
                 "registry" + "/" +\
                 config.pki_subsystem.lower() + "/" +\
-                config.PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE
+                config.PKI_DEPLOYMENT_CONFIGURATION_FILE
         # always verify that configuration file exists
         if not os.path.exists(config.pkideployment_cfg) or\
            not os.path.isfile(config.pkideployment_cfg):
@@ -215,7 +215,9 @@ class PKIConfigParser:
             self.pki_config = ConfigParser.ConfigParser()
             # Make keys case-sensitive!
             self.pki_config.optionxform = str
-            self.pki_config.read(config.pkideployment_cfg)
+            self.pki_config.read([
+                config.PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE,
+                config.pkideployment_cfg])
             config.pki_default_dict = self.pki_config.defaults()
             pkilogging.sensitive_parameters = config.pki_default_dict['sensitive_parameters'].split()
             config.pki_common_dict = dict(self.pki_config._sections['Common'])
@@ -2302,11 +2304,11 @@ class PKIConfigParser:
             # Finalization name/value pairs
             config.pki_master_dict['pki_deployment_cfg_replica'] =\
                 os.path.join(config.pki_master_dict['pki_subsystem_registry_path'],
-                             config.PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE)
+                             config.PKI_DEPLOYMENT_CONFIGURATION_FILE)
             config.pki_master_dict['pki_deployment_cfg_spawn_archive'] =\
                 config.pki_master_dict['pki_subsystem_archive_log_path'] + "/" +\
                 "spawn" + "_" +\
-                config.PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE + "." +\
+                config.PKI_DEPLOYMENT_CONFIGURATION_FILE + "." +\
                 config.pki_master_dict['pki_timestamp']
             config.pki_master_dict['pki_manifest'] =\
                 config.pki_master_dict['pki_subsystem_registry_path'] + "/" +\