Version information
released Oct 4th 2024
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 8.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'openstack-horizon', '25.0.0'Learn more about managing modules with a PuppetfileDocumentation
openstack/horizon — version 25.0.0 Oct 4th 2024
Team and repository tags
horizon
Table of Contents
- Overview - What is the horizon module?
- Module Description - What does the module do?
- Setup - The basics of getting started with horizon
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Release Notes - Release notes for the project
- Contributors - Those with commits
- Repository - The project source code repository
Overview
The horizon module is a part of OpenStack, an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects as part of the core software. The module its self is used to flexibly configure and manage the dashboard service for OpenStack.
Module Description
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.
This module is tested in combination with other modules needed to build and leverage an entire OpenStack software stack.
Setup
What the horizon module affects
- Horizon, the dashboard service for OpenStack.
Installing horizon
puppet module install openstack/horizon
Beginning with horizon
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. We recommend you consult and understand the core openstack documentation.
Define a horizon dashboard
class { 'memcached':
listen_ip => '127.0.0.1',
tcp_port => '11211',
udp_port => '11211',
}
class { 'horizon':
cache_server_ip => '127.0.0.1',
cache_server_port => '11211',
secret_key => '12345',
django_debug => 'True',
api_result_limit => '2000',
}
Implementation
horizon
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.
Limitations
- Only supports Apache using mod_wsgi.
Development
Developer documentation for the entire puppet-openstack project.
Release Notes
Contributors
Repository
8.0.0 and beyond
From 8.0.0 release and beyond, release notes are published on docs.openstack.org.
##2015-11-25 - 7.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Liberty.
####Backwards-incompatible changes
####Features
- allow Orchestration of Image Backend
- add new parameters for multidomain support
- add api_versions parameter
- remove hardcoded 'neutron_options' list
- remove hardcoded 'cinder_options' list
- remove hardcoded 'hypervisor_options' list
- add ssl_no_verify parameter
- make redirect type configurable
- add CUSTOM_THEME_PATH variable
- add tag to package resource
- add cache_backend and cache_options params
####Bugfixes
- do not run collectstatic or compress in Debian
- remove duplicate key for ':servername'
####Maintenance
- acceptance: enable debug & verbosity for OpenStack logs
- initial msync run for all Puppet OpenStack modules
- try to use zuul-cloner to prepare fixtures
- remove class_parameter_defaults puppet-lint check
- fix rspec 3.x syntax
##2015-10-15 - 6.1.0 ###Summary
This is a maintenance release in the Kilo series
####Maintenance
- acceptance: checkout stable/kilo puppet modules
##2015-07-08 - 6.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Kilo.
####Backwards-incompatible changes
- Remove some old deprecated parameters
####Features
- Puppet 4.x support
- Sort policy files in local_settings.py
- Add support for Neutron DVR and L3 HA options
- Collect static files before compressing them
- Add support to add Tuskar-ui config to local_settings
- Add support for WEBROOT in local_settings
- Add 'log_handler' parameter
####Maintenance
- Acceptance tests with Beaker
- Fix spec tests for RSpec 3.x and Puppet 4.x
##2015-06-17 - 5.1.0 ###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Add support for the configuration of OPENSTACK_CINDER_FEATURES
####Bugfixes
- Sort policy files in local_settings.py
####Maintenance
- spec: pin rspec-puppet to 1.0.1
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update .gitreview file for project rename
##2014-11-25 - 5.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Switch the default log level to INFO from DEBUG
####Features
- Use concat to manage local_settings.py
- Add parameters to configure policy files in horizon class
- Add parameter django_session_engine to horizon class
- Change cache_server_ip in horizon class to accept arrays
####Bugfixes
- Fix the default value of compress_offline parameter
- Fix Apache config file default
- Stop setting wsgi_socket_prefix since the apache module takes care of it
- Add workaround for puppet's handling of undef for setting the vhost bind address
- Fix the default MSSQL port in security group rules
##2014-10-16 - 4.2.0 ###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add parameters to configure ALLOWED_HOSTS in settings_local.y and ServerAlias in apache, no longer requiring these values to be the fqdn
- Add support for secure cookies
####Bugfixes
- Fix removal of vhost conf file
##2014-06-19 - 4.1.0 ###Summary
####Features
- Add option to set temporary upload directory for images
####Bugfixes
- Ensure ssl wsgi_process_group is the same as wsgi_daemon_process
####Maintenance
- Pin major gems
##2014-05-01 - 4.0.0 ###Summary
This is a major release for OpenStack Icehouse but contains no API-breaking changes.
####Features
- Add support to pass extra parameters to vhost
- Add support to ensure online cache is present and can be refreshed
- Add support to configure OPENSTACK_HYPERVISOR_FEATURES settings, AVAILABLE_REGIONS, OPENSTACK_NEUTRON_NETWORK
- Add support to disable configuration of Apache
####Bugfixes
- Fix log ownership and WSGIProcess* settings for Red Hat releases
- Fix overriding of policy files in local settings
- Fix SSL bugs
- Improve WSGI configuration
####Maintenance
##2014-03-26 - 3.1.0 ###Summary
This is a feature release in the Havana series.
####Features
- Add option parameterize OPENSTACK_NEUTRON_NETWORK settings
##2014-02-14 - 3.0.1 ###Summary
This is a bugfix release in the Havana series.
####Bugfixes
- Add COMPRESS_OFFLINE option to local_settings to fix broken Ubuntu installation
####Maintenance
##2014-01-16 - 3.0.0 ###Summary
This is a backwards-incompatible major release for OpenStack Havana.
####Backwards-incompatible changes
- Update user and group for Debian family OSes
- Update policy files for RedHat family OSes
- Change keystonedefault_role to _member
####Features
- Enable SSL support with cert/key
- Introduce new parameters: keystone_url, help_url, endpoint type
####Bugfixes
- Improve default logging configuration
- Fix bug to set LOGOUT_URL properly
- Fix user/group regression for Debian
####Maintenance
##2013-10-07 - 2.2.0 ###Summary
This is a bugfix release in the Grizzly series.
####Bugfixes
- Fixed apache 0.9.0 incompatability
####Maintenance
- Various lint fixes
##2013-08-07 - 2.1.0 ###Summary
This is a bugfix release in the Grizzly series.
####Bugfixes
- Update local_settings.py
####Maintenance
- Pin Apache module version
- Various lint fixes
##2013-06-24 - 2.0.0 ###Summary
Initial release on StackForge.
####Features
- httpd config now managed on every platform
- Provide option to enable Horizon's display of block device mount points
Dependencies
- puppetlabs/apache (>=5.0.0 <13.0.0)
- puppetlabs/concat (>=1.0.0 <10.0.0)
- puppetlabs/stdlib (>=5.0.0 <10.0.0)
- saz/memcached (>=2.0.2 <10.0.0)
- openstack/openstacklib (>=25.0.0 <26.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.