Add more docs

Change-Id: I8b0437114e98410508cdb38e43f0fb7b8deb19ce
This commit is contained in:
Alex Ruiz Estradera 2016-11-03 13:00:38 +01:00
parent b22d0facc2
commit fdfbe8efd5
2 changed files with 58 additions and 7 deletions

View File

@ -6,51 +6,67 @@
#
# [*zookeeper_hosts*]
# List of hash [{ip, port}] Zookeeper instances that run in cluster.
#
# [*controller_host*]
# IP of the controller host (or HAProxy ip serving them).
# Default: undef
#
# [*metadata_port*]
# Port where the metadata service will run
# Default: undef
#
# [*shared_secret*]
# 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
#
# [*service_ensure*]
# Whether to ensure the service is running, stopped, etc.
# Default: undef
#
# [*service_enable*]
# Should the service not be enabled by default? Specify it there
# Default: undef
#
# [*agent_config_path*]
# Override the configuration files path
# Default: undef
#
# [*package_ensure*]
# If you want to specify a version for the midolman package, use this parameters
# Default: undef
#
# [*manage_java*]
# If the host doesn't have a Java installation, setting this to true will install Java8
# Default: undef
#
# [*max_heap_size*]
# Specify the heap size of the JavaVM in Gb. Ex: '3'
# Default: undef
#
# [*is_mem*]
# If using MEM Enterprise , set to true
# Default: undef
#
# [*manage_repo*]
# Should manage midonet repositories?
# Default: undef
#
# [*mem_username*]
# If manage_repo is true and is_mem then specify the username to access the packages
# Default: undef
#
# [*mem_password*]
# If manage_repo is true and is_mem then specify the password to access the packages
# Default: undef
#
# [*dhcp_mtu*]
# Specify a mtu for packets here.
# Default: undef

View File

@ -4,27 +4,62 @@
#
# === Parameters
#
# [*is_mem*]
# Boolean variable - If true puppet will install MEM specific services
# Default: false
# [*zookeeper_hosts*]
# List of hash [{ip, port}] Zookeeper instances that run in cluster.
#
# [*manage_repo*]
# Boolean variable - If true puppet will install repositories on given node
# Default: false
#
# [*is_mem*]
# If using MEM Enterprise , set to true
# Default: undef
#
# [*manage_repo*]
# Should manage midonet repositories?
# Default: undef
#
# [*mem_username*]
# Username which will have access to Midokura repositories
# If manage_repo is true and is_mem then specify the username to access the packages
# Default: undef
#
# [*mem_password*]
# Password for User which will be used to access the Midokura repositories
# If manage_repo is true and is_mem then specify the password to access the packages
# Default: undef
#
# [*zookeeper_hosts*]
# List of IPs and ports of hosts where Zookeeper is installed
# [*heap_size_gb*]
# Specify the heap size of the JavaVM in Gb. Ex: '3'
# Default: '4'
#
# [*allinone*]
# If doing an allinone deployment, set to true
# Default: false
#
# [*curator_version*]
# Version of elastic curator
# Default: '3.5'
#
# [*calliope_port*]
# If you want to run calliope on a custom port, specify it
# Default: false
#
# Please note that Keystone port is not mandatory and defaulted to 35537.
#
# === Examples
#
# The easiest way to run the class is:
#
# class {'::midonet::agent':
# zookeeper_hosts => [{'ip' => 'host1',
# 'port' => '2183'},
# {'ip' => 'host2'}],
# shared_secret => 's3cr3t',
# controller_host => $::ipaddress
# }
#
# This call assumes that there is no mem being used, and the controller host is same
# that where midolman is being installed
#
# === Authors
#
# Midonet (http://midonet.org)