3rdparty/modules/horizon/README.md

   1 horizon
   2 =======
   3
   4 5.1.0 - 2014.2 - Juno
   5
   6 #### Table of Contents
   7
   8 1. [Overview - What is the horizon module?](#overview)
   9 2. [Module Description - What does the module do?](#module-description)
  10 3. [Setup - The basics of getting started with horizon](#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 horizon 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 dashboard service for Openstack.
  21
  22 Module Description
  23 ------------------
  24
  25 The horizon module is a thorough attempt to make Puppet capable of managing the entirety of horizon.  Horizon is a fairly classic django application, which results in a fairly simply Puppet module.
  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 horizon module affects**
  33
  34 * horizon, the dashboard service for Openstack.
  35
  36 ### Installing horizon
  37
  38     example% puppet module install puppetlabs/horizon
  39
  40 ### Beginning with horizon
  41
  42 To utilize the horizon module's functionality you will need to declare multiple resources but you'll find that doing so is much less complicated than the other OpenStack component modules.  The following is a modified excerpt from the [openstack module](https://github.com/stackforge/puppet-openstack).  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 **Define a horizon dashboard**
  45
  46 ```puppet
  47 class { 'memcached':
  48   listen_ip => '127.0.0.1',
  49   tcp_port  => '11211',
  50   udp_port  => '11211',
  51 }
  52
  53 class { '::horizon':
  54   cache_server_ip       => '127.0.0.1',
  55   cache_server_port     => '11211',
  56   secret_key            => '12345',
  57   swift                 => false,
  58   django_debug          => 'True',
  59   api_result_limit      => '2000',
  60 }
  61 ```
  62
  63 Implementation
  64 --------------
  65
  66 ### horizon
  67
  68 Horizon is a simple module using the combination of a package, template, and the file_line type.  Most all the configuration lives inside the included local_settings template and the file_line type is for selectively inserting needed lines into configuration files that aren't explicitly managed by the horizon module.
  69
  70 Limitations
  71 ------------
  72
  73 * Only supports Apache using mod_wsgi.
  74
  75 Development
  76 -----------
  77
  78 Developer documentation for the entire puppet-openstack project.
  79
  80 * https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
  81
  82 Contributors
  83 ------------
  84
  85 * https://github.com/stackforge/puppet-horizon/graphs/contributors
  86
  87 Release Notes
  88 -------------
  89
  90 **5.1.0**
  91
  92 * spec: pin rspec-puppet to 1.0.1
  93 * Sort policy files in local_settings.py
  94 * Pin puppetlabs-concat to 1.2.1 in fixtures
  95 * Add support for the configuration of OPENSTACK_CINDER_FEATURES
  96 * Update .gitreview file for project rename
  97
  98 **5.0.0**
  99
 100 * Stable Juno release
 101 * Fixed the default value of compress_offline parameter
 102 * Always manages local_settings.py
 103 * Added parameters to configure policy files in horizon class
 104 * Fixed Apache config file default
 105 * Added parameter django_session_engine to horizon class
 106 * Stops setting wsgi_socket_prefix since the apache module takes care of it
 107 * Adds workaround for puppet's handling of undef for setting the vhost bind address
 108 * Changes cache_server_ip in horizon class to accept arrays
 109 * Switched the default log level to INFO from DEBUG
 110 * Fixed the default MSSQL port in security group rules
 111
 112 **4.2.0**
 113
 114 * Added parameters to configure ALLOWED_HOSTS in settings_local.y and
 115   ServerAlias in apache, no longer requiring these values to be the fqdn
 116 * Fixed removal of vhost conf file
 117 * Added support for secure cookies
 118
 119 **4.1.0**
 120
 121 * Added option to set temporary upload directory for images.
 122 * Ensure ssl wsgi_process_group is the same as wsgi_daemon_process.
 123 * Pined major gems.
 124
 125 **4.0.0**
 126
 127 * Stable Icehouse release.
 128 * Added support to pass extra parameters to vhost.
 129 * Added support to ensure online cache is present and can be refreshed.
 130 * Added support to configure OPENSTACK_HYPERVISOR_FEATURES settings, AVAILABLE_REGIONS, OPENSTACK_NEUTRON_NETWORK.
 131 * Added support to disable configuration of Apache.
 132 * Fixed log ownership and WSGIProcess* settings for Red Hat releases.
 133 * Fixed overriding of policy files in local settings.
 134 * Fixed SSL bugs.
 135 * Improved WSGI configuration.
 136
 137 **3.1.0**
 138
 139 * Added option parameterize OPENSTACK_NEUTRON_NETWORK settings.
 140
 141 **3.0.1**
 142
 143 * Adds COMPRESS_OFFLINE option to local_settings to fix broken Ubuntu installation.
 144
 145 **3.0.0**
 146
 147 * Major release for OpenStack Havana.
 148 * Updated user and group for Debian family OSes.
 149 * Updated policy files for RedHat family OSes.
 150 * Enabled SSL support with cert/key.
 151 * Improved default logging configuration.
 152 * Fixed bug to set LOGOUT_URL properly.
 153 * Introduced new parameters: keystone_url, help_url, endpoint type.
 154 * Fixed user/group regression for Debian.
 155 * Changed keystone_default_role to _member_.
 156
 157 **2.2.0**
 158
 159 * Fixed apache 0.9.0 incompatability.
 160 * Various lint fixes.
 161
 162 **2.1.0**
 163
 164 * Updated local_settings.py.
 165 * Pinned Apache module version.
 166 * Various lint fixes.
 167
 168 **2.0.0**
 169
 170 * Upstream is now part of stackforge.
 171 * httpd config now managed on every platform.
 172 * Provides option to enable Horizon's display of block device mount points.
 173