Add repository docs

Change-Id: I0c26d8f93fe98549acadb8509cebf0ddfa917ffe
This commit is contained in:
Alex Ruiz Estradera 2016-11-03 18:07:48 +01:00
parent af4cbeb310
commit f4d3ef941d

View File

@ -4,33 +4,33 @@
# #
# === Parameters # === Parameters
# #
# [*midonet_repo*] # [*is_mem*]
# Midonet Repository URL location. Please note the version # Whether using MEM (true) or OSS Midonet (false)
# of midonet use to be part of that URL. # Default: false
# Ex: 'http://repo.midonet.org/midonet/v2014.11' #
# [*midonet_openstack_repo*] # [*midonet_version*]
# Midonet Repository URL for the Midonet Neutron Plugin. The version use to # Midonet version to deploy.
# be part of the URL. The package avaiable in this repo (the midonet plugin) # Default: '5.2'
# is released along each OpenStack release (Icehouse, Juno, Kilo...) , not #
# the Midonet OSS release. This is why Midonet maintains different repos. # [*midonet_stage*]
# Ex: 'http://repo.midonet.org/openstack'. # Midonet stage to deploy 'unstable' , 'stable' ...
# [*midonet_thirdparty_repo*] # Default: 'stable'
# Third party software pinned for Midonet stability URL. #
# Ex: 'http://repo.midonet.org/misc'. # [*openstack_release*]
# [*midonet_release*] # Openstack release
# Stage of the package. It can be 'stable', 'testing' or 'unstable'. # Default: 'mitaka'
# Stable by default. #
# [*midoney_key_url*] # [*mem_version*]
# Midonet Key URL path. # Midonet MEM version to deploy.
# [*midonet_key*] # Default: '5.2'
# Midonet GPG key for validate packages. Only override it if you use a #
# different fork of Midonet. # [*mem_username*]
# [*manage_distro_repo*} # MEM repository username
# Choose whether or not to manage the distros' OpenStack repositories (e.g. RDO). # Default: undef
# Defaults to true #
# [*manage_epel_repo*] # [*mem_password*]
# Choose whether or not to manage EPEL under CentOS. # MEM repository password
# Defaults to true # Default: undef
# === Examples # === Examples
# #
# The easiest way to run the class is: # The easiest way to run the class is:
@ -45,28 +45,20 @@
# declaration: # declaration:
# #
# class { 'midonet::repository': # class { 'midonet::repository':
# midonet_repo => 'http://repo.midonet.org/midonet/v2014.11', # midonet_version => '5.2',
# midonet_openstack_repo => 'http://repo.midonet.org/openstack', # mem_version => '5.2',
# midonet_thirdparty_repo => 'http://repo.midonet.org/misc', # openstack_release => 'mitaka'
# midonet_key => '50F18FCF', # mem_username => 'username',
# midonet_stage => 'stable', # mem_password => 'passw0rd'
# midonet_key_url => 'http://repo.midonet.org/packages.midokura.key',
# manage_distro_repo => true,
# manage_epel_repo => true,
# openstack_release => 'juno'
# } # }
# #
# or use a YAML file using the same attributes, accessible from Hiera: # or use a YAML file using the same attributes, accessible from Hiera:
# #
# midonet::repository::midonet_repo: 'http://repo.midonet.org/midonet/v2014.11' # midonet::repository::midonet_version: '5.2'
# midonet::repository::midonet_openstack_repo: 'http://repo.midonet.org/openstack' # midonet::repository::mem_version: '5.2'
# midonet::repository::midonet_thirdparty_repo: 'http://repo.midonet.org/misc' # midonet::repository::openstack_release: 'mitaka'
# midonet::repository::midonet_key: '50F18FCF' # midonet::repository::mem_username: 'username'
# midonet::repository::midonet_stage: 'stable' # midonet::repository::mem_password: 'passw0rd'
# midonet::repository::midonet_key_url: 'http://repo.midonet.org/packages.midokura.key'
# midonet::repository::midonet_distro_repo: true
# midonet::repository::midonet_epel_repo: true
# midonet::repository::openstack_release: 'juno'
# #
# #
# === Authors # === Authors