finalize benchmark schema

Author: kathap

lib/cloud_controller/config_schemas/blobstore_benchmarks_schema.rb

@@ -6,20 +6,19 @@ class BlobstoreBenchmarksSchema < VCAP::Config
       # rubocop:disable Metrics/BlockLength
       define_schema do
         blobstore_section = {
-          optional(:blobstore_type) => String,
-          optional(:blobstore_provider) => String,
+          blobstore_type: String,
+          blobstore_provider: String,
 
-          optional(:fog_connection) => Hash,
           optional(:connection_config) => Hash,
-          optional(:webdav_config) => Hash,
+          optional(:fog_connection) => Hash,
 
-          optional(:fog_aws_storage_options) => Hash,
-          optional(:fog_gcp_storage_options) => Hash,
+          fog_aws_storage_options: Hash,
+          fog_gcp_storage_options: Hash,
 
-          optional(:resource_directory_key) => String,
-          optional(:buildpack_directory_key) => String,
-          optional(:app_package_directory_key) => String,
-          optional(:droplet_directory_key) => String,
+          resource_directory_key: String,
+          buildpack_directory_key: String,
+          app_package_directory_key: String,
+          droplet_directory_key: String,
 
           optional(:maximum_size) => Integer,
           optional(:minimum_size) => Integer,
@@ -29,30 +28,30 @@ class BlobstoreBenchmarksSchema < VCAP::Config
         }
 
         {
-          optional(:logging) => {
-            optional(:level) => String,
-            optional(:file) => String,
-            optional(:syslog) => String,
-            optional(:stdout_sink_enabled) => bool
+          logging: {
+            level: String, # debug, info, etc.
+            file: String, # Log file to use
+            syslog: String, # Name to associate with syslog messages (should start with 'vcap.')
+            stdout_sink_enabled: bool
           },
 
           db: {
-            optional(:database) => Hash,
-            optional(:db_connection_string) => String,
-            optional(:max_connections) => Integer,
-            optional(:pool_timeout) => Integer,
-            optional(:log_level) => String,
-            optional(:log_db_queries) => bool,
-            optional(:ssl_verify_hostname) => bool,
-            optional(:connection_validation_timeout) => Integer,
+            optional(:database) => Hash, # db connection hash for sequel\
+            max_connections: Integer, # max connections in the connection pool
+            pool_timeout: Integer, # timeout before raising an error when connection can't be established to the db
+            log_level: String, # debug, info, etc.
+            log_db_queries: bool,
+            ssl_verify_hostname: bool,
+            connection_validation_timeout: Integer,
             optional(:ca_cert_path) => String
           },
-          optional(:storage_cli_config_file_resource_pool) => String,
-          optional(:storage_cli_config_file_buildpacks) => String,
-          optional(:storage_cli_config_file_packages) => String,
-          optional(:storage_cli_config_file_droplets) => String,
+          storage_cli_config_file_resource_pool: String,
+          storage_cli_config_file_buildpacks: String,
+          storage_cli_config_file_packages: String,
+          storage_cli_config_file_droplets: String,
+
+          db_encryption_key: enum(String, NilClass),
 
-          optional(:db_encryption_key) => enum(String, NilClass),
           optional(:database_encryption) => {
             keys: Hash,
             current_key_label: String,
@@ -64,10 +63,10 @@ class BlobstoreBenchmarksSchema < VCAP::Config
           packages: blobstore_section,
           droplets: blobstore_section,
 
-          optional(:pid_filename) => String,
-          optional(:index) => Integer,
-          optional(:name) => String,
-          optional(:default_app_ssh_access) => bool
+          pid_filename: String,
+          index: Integer, # Component index (cc-0, cc-1, etc)
+          name: String, # Component name (api_z1, api_z2)
+          default_app_ssh_access: bool,
         }
       end
       # rubocop:enable Metrics/BlockLength