3rdparty/modules/nova/README.md

   1 nova
   2 ====
   3
   4 5.1.0 - 2014.2 - Juno
   5
   6 #### Table of Contents
   7
   8 1. [Overview - What is the nova module?](#overview)
   9 2. [Module Description - What does the module do?](#module-description)
  10 3. [Setup - The basics of getting started with nova](#setup)
  11 4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
  12 5. [Limitations - OS compatibility, etc.](#limitations)
  13 6. [Development - Guide for contributing to the module](#development)
  14 7. [Contributors - Those with commits](#contributors)
  15 8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
  16
  17 Overview
  18 --------
  19
  20 The nova module is a part of [Stackforge](https://github.com/stackforge), an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software.  The module its self is used to flexibly configure and manage the compute service for Openstack.
  21
  22 Module Description
  23 ------------------
  24
  25 The nova module is a thorough attempt to make Puppet capable of managing the entirety of nova.  This includes manifests to provision such things as keystone endpoints, RPC configurations specific to nova, and database connections.  Types are shipped as part of the nova module to assist in manipulation of configuration files.
  26
  27 This module is tested in combination with other modules needed to build and leverage an entire Openstack software stack.  These modules can be found, all pulled together in the [openstack module](https://github.com/stackforge/puppet-openstack).
  28
  29 Setup
  30 -----
  31
  32 **What the nova module affects:**
  33
  34 * nova, the compute service for Openstack.
  35
  36 ### Installing nova
  37
  38     example% puppet module install puppetlabs/nova
  39
  40 ### Beginning with nova
  41
  42 To utilize the nova module's functionality you will need to declare multiple resources.  The following is a modified excerpt from the [openstack module](https://github.com/stackforge/puppet-openstack).  This is not an exhaustive list of all the components needed, we recommend you consult and understand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core openstack](http://docs.openstack.org) documentation.
  43
  44 ```puppet
  45 class { 'nova':
  46   database_connection => 'mysql://nova:a_big_secret@127.0.0.1/nova?charset=utf8',
  47   rabbit_userid       => 'nova',
  48   rabbit_password     => 'an_even_bigger_secret',
  49   image_service       => 'nova.image.glance.GlanceImageService',
  50   glance_api_servers  => 'localhost:9292',
  51   verbose             => false,
  52   rabbit_host         => '127.0.0.1',
  53 }
  54
  55 class { 'nova::compute':
  56   enabled                       => true,
  57   vnc_enabled                   => true,
  58 }
  59
  60 class { 'nova::compute::libvirt':
  61   migration_support => true,
  62 }
  63 ```
  64
  65 Implementation
  66 --------------
  67
  68 ### nova
  69
  70 nova is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
  71
  72 Limitations
  73 -----------
  74
  75 * Supports libvirt, xenserver and vmware compute drivers.
  76 * Tested on EL and Debian derivatives.
  77
  78 Development
  79 -----------
  80
  81 Developer documentation for the entire puppet-openstack project.
  82
  83 * https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
  84
  85 Contributors
  86 ------------
  87
  88 * https://github.com/stackforge/puppet-nova/graphs/contributors
  89
  90 Release Notes
  91 -------------
  92
  93 **5.1.0**
  94
  95 * move setting of novncproxy_base_url
  96 * Added parameters for availability zones configuration
  97 * crontab: ensure nova-common is installed before
  98 * Correct docs on format for nova::policy data
  99 * Allow libvirt secret key setting from param
 100 * Fix behaviour of 'set-secret-value virsh' exec
 101 * MySQL: change default MySQL collate to utf8_general_ci
 102 * Pin puppetlabs-concat to 1.2.1 in fixtures
 103 * Make group on /var/log/nova OS specific
 104 * IPv6 support for migration check.
 105 * Database: add slave_connection support
 106 * Correct references to ::nova::rabbit_* variables
 107 * Add optional network_api_class parameter to nova::network::neutron class
 108 * Add Nova Aggregate support
 109 * rpc_backend: simplify parameters
 110 * supporting lxc cpu mode Fixing the default cpu_mode from None to none
 111 * virsh returns a list of secret uuids, not keyring names
 112 * Pin fixtures for stables branches
 113 * Add serialproxy configuration
 114 * Switch to TLSv1 as SSLv3 is considered insecure and is disabled by default
 115 * Disable file injection when using RBD as compute ephemeral storage
 116 * Add PCI Passthrough/SR-IOV support
 117 * Add Ironic support into nova puppet modules
 118 * spec: pin rspec-puppet to 1.0.1
 119 * Correct section for cell_type nova.conf parameter
 120 * crontab: ensure the script is run with shell
 121 * Configure database parameters on the right nodes
 122
 123 **5.0.0**
 124
 125 * Stable Juno release
 126 * Added tags to all nova packages
 127 * Added parameter dhcp_domain to nova class
 128 * Updated the [glance] and [neutron] section parameters for Juno
 129 * Fixed potential duplicate declaration errors for sysctl::value in nova::network
 130 * Fixed dependency cycle in nova::migration::libvirt
 131 * Updated the libvirtd init script path for Debian
 132 * Added parameters for nova service validation to nova::api
 133 * Added nova::policy to control policy.json
 134 * Fixed the rabbit_virtual_host default in nova::cells
 135 * Bumped stdlib dependency to >=4.0.0
 136 * Added force_raw_images parameter to nova::compute class
 137 * Replaced usage of the keyword type with the string 'type' since type is a reserved keyword in puppet 3.7
 138 * Added parameter ec2_workers to nova::api
 139 * Fixed bug in usage of --vlan versus --vlan_start in nova_network provider
 140 * Added parameter rabbit_ha_queues to nova class
 141 * Added parameter pool to nova_floating type
 142 * Added parameters to control whether to configure keystone users
 143 * Added nova::cron::archive_deleted_rows class to create a crontab for archiving deleted database rows
 144 * Changed the keystone_service to only be configured if the endpoint is to be configured
 145 * Added parameter keystone_ec2_url to nova::api
 146 * Added the ability to override the keystone service name in ceilometer::keystone::auth
 147 * Removed dynamic scoping of File resources in nova class
 148 * Add parameter workers to in nova::conductor and deprecate conductor_workers in nova::api
 149 * Update nova quota parameters for Juno
 150 * Migrated the ceilometer::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
 151 * Removed deprecation notice for sectionless nova_config names
 152 * Added parameter vnc_keymap in nova::compute
 153 * Added parameter osapi_v3 to nova::api
 154
 155 **4.2.0**
 156
 157 * Added option to configure libvirt service name via class parameters
 158 * Added support for multiple SSL APIs
 159 * Added option to configure os_region_name in the nova config
 160 * Corrected resource dependencies on the nova user
 161 * Fixed os version fact comparison for RedHat-based operating systems
 162   for specifying service provider
 163 * Fixed ssl parameter requirements when using kombu and rabbit
 164 * Added class for extended logging options
 165
 166 **4.1.0**
 167
 168 * Added API v3 endpoint support.
 169 * Added configuration of rbd keyring name.
 170 * Added support for run Nova SSL endpoints.
 171 * Updated RabbitMQ dependency.
 172 * Updated mysql charset to UTF8.
 173 * Pinned major gems.
 174
 175 **4.0.0**
 176
 177 * Stable Icehouse release.
 178 * Added support for RHEL 7.
 179 * Added support for metadata and conductor workers.
 180 * Added support for vif_plugging parameters.
 181 * Added support for puppetlabs-mysql 2.2 and greater.
 182 * Added support for instance_usage_audit parameters.
 183 * Added support to manage the nova uid/gid for NFS live migration..
 184 * Added nova::config to handle additional custom options.
 185 * Added support to disable installation of nova utilities.
 186 * Added support for durable RabbitMQ queues.
 187 * Added SSL support for RabbitMQ.
 188 * Added support for nova-objectstore bind address.
 189 * Updated support for notification parameters.
 190 * Fixed packaging bugs.
 191 * Fixed report_interval configuration.
 192 * Fixed file location for nova compute rbd secret.
 193
 194 **3.2.1**
 195
 196 * Fixed consoleauth/spice resource duplication on Red Hat systems.
 197
 198 **3.2.0**
 199
 200 * Replace pip with native package manager for VMWare.
 201 * Deprecated logdir parameter in favor of log_dir.
 202 * Allows log_dir to be set to false in order to disable file logging.
 203 * Enables libvirt at boot.
 204 * Adds RBD backend support for VM image storage.
 205 * Parameterizes libvirt cpu_mode and disk_cachemodes.
 206 * Adds support for https auth endpoints.
 207 * Adds ability to disable installation of nova utilities.
 208
 209 **3.1.0**
 210
 211 * Minor release for OpenStack Havana.
 212 * Add libguestfs-tools package to nova utilities.
 213 * Fixed vncproxy package naming for Ubuntu.
 214 * Fixed libvirt configuration.
 215
 216 **3.0.0**
 217
 218 * Major release for OpenStack Havana.
 219 * Removed api-paste.ini configuration.
 220 * Adds support for live migrations with using the libvirt Nova driver.
 221 * Fixed bug to ensure keystone endpoint is set before service is started.
 222 * Fixed nova-spiceproxy support on Ubuntu.
 223 * Added support for VMWareVCDriver.
 224
 225 **2.2.0**
 226
 227 * Added a check to install bridge-utils only if needed.
 228 * Added syslog support.
 229 * Added installation of pm-utils for VM power management support.
 230 * Fixed cinder include dependency bug.
 231 * Various bug and lint fixes.
 232
 233 **2.1.0**
 234
 235 * Added support for X-Forwarded-For HTTP Headers.
 236 * Added html5 spice support.
 237 * Added config drive support.
 238 * Added RabbitMQ clustering support.
 239 * Added memcached support.
 240 * Added SQL idle timeout support.
 241 * Fixed allowed_hosts/database connection bug.
 242 * Pinned RabbitMQ and database module versions.
 243
 244 **2.0.0**
 245
 246 * Upstream is now part of stackforge.
 247 * The ini_file type is now used by nova_config.
 248 * Support for nova-conductor added.
 249 * Networks can now be labeled by Class['nova::manage::network'].
 250 * The Apache Qpid message broker is available as an RPC backend.
 251 * Further compatibility fixes for RHEL and its derivatives.
 252 * Postgres support added.
 253 * Adjustments to help in supporting the still in development neutron module.
 254 * Config changes can be hidden from Puppet logs.
 255 * Move from deprecated rabbit_notifier to rpc_notifier.
 256 * Various cleanups and bug fixes.