Add more docs!

Change-Id: I45b76d6c4e37c8e50c437e874327d1e17cb184e3

manifests/agent.pp

@@ -48,7 +48,7 @@
 #     Default: undef
 #
 # [*max_heap_size*]
-#  Specify the heap size of the JavaVM in Gb. Ex: '3'
+#  Specify the heap size of the JavaVM. Ex: '512M'
 #     Default: undef
 #
 # [*is_mem*]

manifests/agent/run.pp

@@ -21,33 +21,29 @@
 #  Metadata shared secret
 #     Default: undef
 #
-# [*package_name*]
-#  Name of the midonet agent (midolman) package.
-#     Default: undef
-#
 # [*service_name*]
 #  Name of the midolman service
-#     Default: undef
+#     Default: midolman
 #
 # [*service_ensure*]
 #  Whether to ensure the service is running, stopped, etc.
-#     Default: undef
+#     Default: running
 #
 # [*service_enable*]
 #  Should the service not be enabled by default? Specify it there
-#     Default: undef
+#     Default: true
 #
 # [*agent_config_path*]
 #  Override the configuration files path
-#     Default: undef
+#     Default: /etc/midolman/midolman.conf
 #
 # [*jvm_config_path*]
 #  Override the jvm config files path
-#     Default: undef
+#     Default: /etc/midolman/midolman-env.sh
 #
 # [*max_heap_size*]
-#  Specify the heap size of the JavaVM in Gb. Ex: '3'
-#     Default: undef
+#  Specify the heap size of the JavaVM in Gb. Ex: '1024M'
+#     Default: '1024M'
 #
 # [*dhcp_mtu*]
 #  Specify a mtu for packets here.

manifests/cluster.pp

@@ -51,10 +51,10 @@
 #   Port where the keystone service is running
 #     Default: undef
 # [*max_heap_size*]
-#   Heap size of midonet cluster JVM , in gb . Ex: '4'
+#   Heap size of midonet cluster JVM. Ex '1024M'
 #     Default: undef
 # [*heap_newsize*]
-#   Xmx heap size value in gb . Ex '4'
+#   Xmx heap size value in gb . Ex '512M'
 #     Default: undef
 # [*is_mem*]
 #   Whether to install cluster mem packages or not
@@ -66,7 +66,7 @@
 #   Is MEM insights using SSL?
 #     Default: undef
 # [*analytics_ip*]
-#   Heap size of midonet cluster JVM , in gb . Ex: '4'
+#   IP of the Analytics node
 #     Default: undef
 
 #

manifests/cluster/install.pp

@@ -1,6 +1,19 @@
 # == Class: midonet::midonet_api::install
 # Check out the midonet::midonet_api class for a full understanding of
 # how to use the midonet_api resource
+# === Parameters
+#
+# [*package_ensure*]
+#   Status to ensure for the midonet cluster package
+#   Default: 'present'
+#
+# [*package_name*]
+#   Name of the midonet cluster package
+#   Default: 'midonet-cluster'
+#
+# [*is_mem*]
+#   Whether or not install the MEM related packages
+#   Default: false
 #
 # === Authors
 #

manifests/cluster/run.pp

@@ -2,6 +2,67 @@
 # Check out the midonet::cluster class for a full understanding of
 # how to use the cluster resource
 #
+#
+# === Parameters
+#
+# [*zookeeper_hosts*]
+#   List of hash [{ip, port}] Zookeeper instances that run in cluster.
+# [*cassandra_servers*]
+#   List of IP's / IP:PORT where cassandra servers are running
+# [*cassandra_rep_factor*]
+#   Cassandra replication factor
+# [*keystone_admin_token*]
+#   Keystone admin token
+# [*keystone_host*]
+#   Host where keystone is running
+# [*keystone_protocol*]
+#   Protocol ( http / https ) to make the keystone requests
+#     Default: 'http'
+# [*keystone_tenant_name*]
+#   Name of the keystone tenant
+#     Default: 'admin'
+# [*package_ensure*]
+#   Ensure 'present', 'absent' ...
+#     Default: present
+# [*service_name*]
+#   Name of the midonet cluster service
+#     Default: 'midonet_cluster'
+# [*service_ensure*]
+#   Ensure 'running' , 'stopped' ... status of service
+#     Default: running
+# [*service_enable*]
+#  Should enable service on startup?
+#     Default: true
+# [*cluster_config_path*]
+#   Path to store the midonet cluster configuration files
+#     Default: /etc/midonet/midonet.conf
+# [*cluster_jvm_config_path*]
+#   Path to store the midonet cluster JVM configuration files
+#     Default: /etc/midonet-cluster/midonet-cluster-env.sh
+# [*cluster_host*]
+#   IP to bind to the midonet cluster service
+#     Default: '0.0.0.0'
+# [*cluster_port*]
+#   Port to bind the midonet cluster service
+#     Default: '8181'
+# [*keystone_port*]
+#   Port where the keystone service is running
+#     Default: '35357'
+# [*max_heap_size*]
+#   Heap size of midonet cluster JVM , . Ex: '1024M'
+#     Default: '1024M'
+# [*heap_newsize*]
+#   Xms heap size value in gb . Ex '512M'
+#     Default: '512M'
+# [*is_insights*]
+#  Whether using MEM Insights or not
+#     Default: false
+# [*insights_ssl*]
+#   Is MEM insights using SSL?
+#     Default: undef
+# [*analytics_ip*]
+#   IP of the Analytics node
+#     Default: undef
 # === Authors
 #
 # Midonet (http://midonet.org)