Fix parameters and headers inconsistency in the puppet manifests.

As we are staring to manually check overcloud services
the first step is to check that the puppet profiles
are all aligned.

Changes applied:

  No logic added or removed in this submission.

  Removed unused parameters.

  Align header comments structure.

  All profiles parameters sorted following:
  "Mandatory params first sorted alphabetically
  then optional params sorted alphabetically."

Note: Following submissions will check pacemaker,
cinder, mistral and redis services in the base profiles
as some of them has the $pacemaker_master parameter
defaulted to true.

Change-Id: I2f91c3f6baa33f74b5625789eec83233179a9655

11 files changed, 69 insertions, 88 deletions

diff --git a/manifests/profile/base/neutron/agents/midonet.pp b/manifests/profile/base/neutron/agents/midonet.pp
index 52cafa9..f2ce94a 100644
--- a/manifests/profile/base/neutron/agents/midonet.pp
+++ b/manifests/profile/base/neutron/agents/midonet.pp
@@ -18,26 +18,24 @@
 #
 # === Parameters
 #
-# [*neutron_api_node_ips*]
-#   (Optional) The IPs of the Neutron API hosts
-#   Defaults to hiera('neutron_api_node_ips')
-#
 # [*midonet_libvirt_qemu_data*]
 #   (Optional) qemu.conf data for midonet.
 #   Defaults to hiera('midonet_libvirt_qemu_data')
 #
+# [*neutron_api_node_ips*]
+#   (Optional) The IPs of the Neutron API hosts
+#   Defaults to hiera('neutron_api_node_ips')
+#
 # [*step*]
 #   (Optional) The current step of the deployment
 #   Defaults to hiera('step')
 #
 class tripleo::profile::base::neutron::agents::midonet (
-  $neutron_api_node_ips       = hiera('neutron_api_node_ips', ''),
-  $midonet_libvirt_qemu_data  = hiera('midonet_libvirt_qemu_data', ''),
-  $step                       = hiera('step'),
+  $midonet_libvirt_qemu_data = hiera('midonet_libvirt_qemu_data', ''),
+  $neutron_api_node_ips      = hiera('neutron_api_node_ips', ''),
+  $step                      = hiera('step'),
 ) {
-
   if $step >= 4 {
-
     # TODO(devvesa) provide non-controller ips for these services
     class { '::tripleo::network::midonet::agent':
       zookeeper_servers => $neutron_api_node_ips,
@@ -50,7 +48,5 @@ class tripleo::profile::base::neutron::agents::midonet (
         content => hiera('midonet_libvirt_qemu_data')
       }
     }
-
   }
-
 }
diff --git a/manifests/profile/base/neutron/agents/nuage.pp b/manifests/profile/base/neutron/agents/nuage.pp
index c50feb2..80beceb 100644
--- a/manifests/profile/base/neutron/agents/nuage.pp
+++ b/manifests/profile/base/neutron/agents/nuage.pp
@@ -18,36 +18,34 @@
 #
 # === Parameters
 #
-# [*nova_os_tenant_name*]
-#   (Optional) Nova tenant name
-#   Defaults to hiera('nova_os_tenant_name')
-#
-# [*nova_os_password*]
-#   (Optional) Nova password
-#   Defaults to hiera('nova_password')
+# [*nova_auth_ip*]
+#   (Optional) Nova auth IP
+#   Defaults to hiera('keystone_public_api_virtual_ip')
 #
 # [*nova_metadata_ip*]
 #   (Optional) Nova metadata node IPs
 #   Defaults to hiera('nova_metadata_node_ips')
 #
-# [*nova_auth_ip*]
-#   (Optional) Nova auth IP
-#   Defaults to hiera('keystone_public_api_virtual_ip')
+# [*nova_os_password*]
+#   (Optional) Nova password
+#   Defaults to hiera('nova_password')
+#
+# [*nova_os_tenant_name*]
+#   (Optional) Nova tenant name
+#   Defaults to hiera('nova_os_tenant_name')
 #
 # [*step*]
 #   (Optional) The current step of the deployment
 #   Defaults to hiera('step')
 #
 class tripleo::profile::base::neutron::agents::nuage (
-  $nova_os_tenant_name       = hiera('nova::api::admin_tenant_name', ''),
-  $nova_os_password          = hiera('nova_password', ''),
-  $nova_metadata_ip          = hiera('nova_metadata_node_ips', ''),
-  $nova_auth_ip              = hiera('keystone_public_api_virtual_ip', ''),
-  $step                      = hiera('step'),
+  $nova_auth_ip        = hiera('keystone_public_api_virtual_ip', ''),
+  $nova_metadata_ip    = hiera('nova_metadata_node_ips', ''),
+  $nova_os_password    = hiera('nova_password', ''),
+  $nova_os_tenant_name = hiera('nova::api::admin_tenant_name', ''),
+  $step                = hiera('step'),
 ) {
-
   if $step >= 4 {
-
     include ::nuage::vrs
 
     class { '::nuage::metadataagent':
@@ -56,7 +54,5 @@ class tripleo::profile::base::neutron::agents::nuage (
       nova_metadata_ip    => $nova_metadata_ip,
       nova_auth_ip        => $nova_auth_ip,
     }
-
   }
-
 }
diff --git a/manifests/profile/base/neutron/dhcp.pp b/manifests/profile/base/neutron/dhcp.pp
index a313478..24b1a35 100644
--- a/manifests/profile/base/neutron/dhcp.pp
+++ b/manifests/profile/base/neutron/dhcp.pp
@@ -24,7 +24,7 @@
 #   Defaults to hiera('step')
 #
 class tripleo::profile::base::neutron::dhcp (
-  $step                    = hiera('step'),
+  $step = hiera('step'),
 ) {
   if $step >= 4 {
     include ::tripleo::profile::base::neutron
diff --git a/manifests/profile/base/neutron/l3.pp b/manifests/profile/base/neutron/l3.pp
index 2b57555..14ffa82 100644
--- a/manifests/profile/base/neutron/l3.pp
+++ b/manifests/profile/base/neutron/l3.pp
@@ -18,17 +18,13 @@
 #
 # === Parameters
 #
-# [*neutron_ovs_use_veth*]
-#   (Optional) Whether to set ovs_use_veth (for older kernel support)
-#   Defaults to hiera('neutron_ovs_use_veth', false)
-#
 # [*step*]
 #   (Optional) The current step in deployment. See tripleo-heat-templates
 #   for more details.
 #   Defaults to hiera('step')
 #
 class tripleo::profile::base::neutron::l3 (
-  $step           = hiera('step'),
+  $step = hiera('step'),
 ) {
   if $step >= 4 {
     include ::tripleo::profile::base::neutron
diff --git a/manifests/profile/base/neutron/metadata.pp b/manifests/profile/base/neutron/metadata.pp
index d7b4c99..4cc6748 100644
--- a/manifests/profile/base/neutron/metadata.pp
+++ b/manifests/profile/base/neutron/metadata.pp
@@ -24,7 +24,7 @@
 #   Defaults to hiera('step')
 #
 class tripleo::profile::base::neutron::metadata (
-  $step           = hiera('step'),
+  $step = hiera('step'),
 ) {
   if $step >= 4 {
     include ::tripleo::profile::base::neutron
diff --git a/manifests/profile/base/neutron/midonet.pp b/manifests/profile/base/neutron/midonet.pp
index 3276b82..c8f3044 100644
--- a/manifests/profile/base/neutron/midonet.pp
+++ b/manifests/profile/base/neutron/midonet.pp
@@ -18,69 +18,63 @@
 #
 # === Parameters
 #
-# [*vip*]
-#   (Optional) Public Virtual IP Address for this cloud
-#   Defaults to hiera('public_virtual_ip')
+# [*admin_password*]
+#   (Optional) Admin Password for Midonet API
+#   Defaults to hiera('admin_password')
+#
+# [*bind_address*]
+#   (Optional) The address to bind Cassandra and Midonet API to
+#   Defaults to hiera('neutron::bind_host')
 #
 # [*keystone_admin_token*]
 #   (Optional) The Keystone Admin Token
 #   Defaults to hiera('keystone::admin_token')
 #
-# [*zookeeper_client_ip*]
-#   (Optional) The IP of the Zookeeper Client
-#   Defaults to hiera('neutron::bind_host')
-#
-# [*zookeeper_hostnames*]
-#   (Optional) The IPs of the Zookeeper Servers
-#   Defaults to hiera('controller_node_names')
-#
 # [*neutron_api_node_ips*]
 #   (Optional) The IPs of the Neutron API hosts
 #   Defaults to hiera('neutron_api_node_ips')
 #
-# [*bind_address*]
-#   (Optional) The address to bind Cassandra and Midonet API to
-#   Defaults to hiera('neutron::bind_host')
-#
-# [*admin_password*]
-#   (Optional) Admin Password for Midonet API
-#   Defaults to hiera('admin_password')
-#
-# [*zk_on_controller*]
-#   (Optional) Whether to put zookeeper on the controllers
-#   Defaults to hiera('enable_zookeeper_on_controller')
-#
-# [*neutron_auth_tenant*]
-#   (Optional) Tenant to use for Neutron authentication
-#   Defaults to hiera('neutron::server::auth_tenant')
-#
 # [*neutron_auth_password*]
 #   (Optional) Password to use for Neutron authentication
 #   Defaults to hiera('neutron::server::auth_password')
 #
-# [*step*]
-#   (Optional) The current step in deployment. See tripleo-heat-templates
-#   for more details.
-#   Defaults to hiera('step')
+# [*neutron_auth_tenant*]
+#   (Optional) Tenant to use for Neutron authentication
+#   Defaults to hiera('neutron::server::auth_tenant')
 #
 # [*step*]
 #   (Optional) The current step of the deployment
 #   Defaults to hiera('step')
 #
+# [*vip*]
+#   (Optional) Public Virtual IP Address for this cloud
+#   Defaults to hiera('public_virtual_ip')
+#
+# [*zk_on_controller*]
+#   (Optional) Whether to put zookeeper on the controllers
+#   Defaults to hiera('enable_zookeeper_on_controller')
+#
+# [*zookeeper_client_ip*]
+#   (Optional) The IP of the Zookeeper Client
+#   Defaults to hiera('neutron::bind_host')
+#
+# [*zookeeper_hostnames*]
+#   (Optional) The IPs of the Zookeeper Servers
+#   Defaults to hiera('controller_node_names')
+#
 class tripleo::profile::base::neutron::midonet (
-  $vip                   = hiera('public_virtual_ip'),
+  $admin_password        = hiera('admin_password', ''),
+  $bind_address          = hiera('neutron::bind_host', ''),
   $keystone_admin_token  = hiera('keystone::admin_token', ''),
-  $zookeeper_client_ip   = hiera('neutron::bind_host', ''),
-  $zookeeper_hostnames   = hiera('controller_node_names', ''),
   $neutron_api_node_ips  = hiera('neutron_api_node_ips', ''),
-  $bind_address          = hiera('neutron::bind_host', ''),
-  $admin_password        = hiera('admin_password', ''),
-  $zk_on_controller      = hiera('enable_zookeeper_on_controller', ''),
-  $neutron_auth_tenant   = hiera('neutron::server::auth_tenant', ''),
   $neutron_auth_password = hiera('neutron::server::auth_password', ''),
+  $neutron_auth_tenant   = hiera('neutron::server::auth_tenant', ''),
   $step                  = hiera('step'),
+  $vip                   = hiera('public_virtual_ip'),
+  $zk_on_controller      = hiera('enable_zookeeper_on_controller', ''),
+  $zookeeper_client_ip   = hiera('neutron::bind_host', ''),
+  $zookeeper_hostnames   = hiera('controller_node_names', ''),
 ) {
-
   include ::tripleo::profile::base::neutron
   include ::tripleo::profile::base::neutron::agents::midonet
 
diff --git a/manifests/profile/base/neutron/ovs.pp b/manifests/profile/base/neutron/ovs.pp
index f801511..a4e0cd3 100644
--- a/manifests/profile/base/neutron/ovs.pp
+++ b/manifests/profile/base/neutron/ovs.pp
@@ -26,7 +26,6 @@
 class tripleo::profile::base::neutron::ovs(
   $step           = hiera('step'),
 ) {
-
   include ::tripleo::profile::base::neutron
 
   if $step >= 4 {
diff --git a/manifests/profile/base/neutron/plugins/ml2.pp b/manifests/profile/base/neutron/plugins/ml2.pp
index 0193615..c89bc02 100644
--- a/manifests/profile/base/neutron/plugins/ml2.pp
+++ b/manifests/profile/base/neutron/plugins/ml2.pp
@@ -18,23 +18,23 @@
 #
 # === Parameters
 #
-# [*mechanism_drivers*]
-#   (Optional) The mechanism drivers to use with the Ml2 plugin
-#   Defaults to hiera('neutron::plugins::ml2::mechanism_drivers')
-#
 # [*bootstrap_node*]
 #   (Optional) The hostname of the node responsible for bootstrapping tasks
 #   Defaults to hiera('bootstrap_nodeid')
 #
+# [*mechanism_drivers*]
+#   (Optional) The mechanism drivers to use with the Ml2 plugin
+#   Defaults to hiera('neutron::plugins::ml2::mechanism_drivers')
+#
 # [*step*]
 #   (Optional) The current step in deployment. See tripleo-heat-templates
 #   for more details.
 #   Defaults to hiera('step')
-
+#
 class tripleo::profile::base::neutron::plugins::ml2 (
-  $mechanism_drivers  = hiera('neutron::plugins::ml2::mechanism_drivers'),
-  $bootstrap_node     = hiera('bootstrap_nodeid', undef),
-  $step               = hiera('step'),
+  $bootstrap_node    = hiera('bootstrap_nodeid', undef),
+  $mechanism_drivers = hiera('neutron::plugins::ml2::mechanism_drivers'),
+  $step              = hiera('step'),
 ) {
   if $::hostname == downcase($bootstrap_node) {
     $sync_db = true
diff --git a/manifests/profile/base/neutron/plugins/nuage.pp b/manifests/profile/base/neutron/plugins/nuage.pp
index 4ada340..0843ec4 100644
--- a/manifests/profile/base/neutron/plugins/nuage.pp
+++ b/manifests/profile/base/neutron/plugins/nuage.pp
@@ -24,7 +24,7 @@
 #   (Optional) The current step in deployment. See tripleo-heat-templates
 #   for more details.
 #   Defaults to hiera('step')
-
+#
 class tripleo::profile::base::neutron::plugins::nuage (
   $bootstrap_node = hiera('bootstrap_nodeid', undef),
   $step           = hiera('step'),
diff --git a/manifests/profile/base/neutron/plugins/opencontrail.pp b/manifests/profile/base/neutron/plugins/opencontrail.pp
index 6cd710a..fbf46e7 100644
--- a/manifests/profile/base/neutron/plugins/opencontrail.pp
+++ b/manifests/profile/base/neutron/plugins/opencontrail.pp
@@ -24,7 +24,7 @@
 #   (Optional) The current step in deployment. See tripleo-heat-templates
 #   for more details.
 #   Defaults to hiera('step')
-
+#
 class tripleo::profile::base::neutron::plugins::opencontrail (
   $bootstrap_node = hiera('bootstrap_nodeid', undef),
   $step           = hiera('step'),
diff --git a/manifests/profile/base/neutron/plugins/plumgrid.pp b/manifests/profile/base/neutron/plugins/plumgrid.pp
index efd75ac..bc73d29 100644
--- a/manifests/profile/base/neutron/plugins/plumgrid.pp
+++ b/manifests/profile/base/neutron/plugins/plumgrid.pp
@@ -26,7 +26,7 @@
 #   (Optional) The current step in deployment. See tripleo-heat-templates
 #   for more details.
 #   Defaults to hiera('step')
-
+#
 class tripleo::profile::base::neutron::plugins::plumgrid (
   $bootstrap_node = hiera('bootstrap_nodeid', undef),
   $step           = hiera('step'),