OpenStack Horizon Puppet Module
Go to file
Jiri Podivin 71e676706a setuptools: Disable auto discovery
The latest release of setuptools 61.0 made a breaking change[1] and
because of this change 'pip install' fails with the following error.

~~~
error: Multiple top-level packages discovered in a flat-layout:
['lib', 'spec', 'manifests', 'releasenotes'].
~~~

Users that don't set 'packages', 'py_modules', or configuration'
are still likely to observe the auto-discovery behavior, which may
halt the build if the project contains multiple directories and/or
multiple Python files directly under the project root.

To disable auto discovery, one can do below in setup.py

~~~
setuptools.setup(..,packages=[],..)
~~~

or

~~~
setuptools.setup(..,py_modules=[],..)
~~~

[1] https://github.com/pypa/setuptools/issues/3197

Note setup.py is not used to install puppet modules. However it is used
to generate a release note, thus should be fixed.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: Iea08dac23cab190bed38cfafb230160648bb94a3
2022-03-29 10:38:58 +02:00
doc Update openstackdocstheme to the latest version 2021-09-29 16:06:50 +08:00
manifests Recommend dashboard-specific classes 2022-02-13 13:35:02 +09:00
releasenotes remove unicode literal from code 2022-03-08 09:14:17 +09:00
spec Correction of syntax errors. 2022-03-08 02:04:46 +00:00
templates Fix syntax error in individual dashboard settings 2022-03-23 01:45:37 +09:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:24 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:32 +00:00
.sync.yml Initial msync run for all Puppet OpenStack modules 2015-08-06 20:34:34 +02:00
.zuul.yaml TripleO jobs: Replace CentOS 8 jobs by CentOS 9 jobs 2022-02-09 22:51:38 +09:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:18:18 +02:00
CHANGELOG.md Release 8.0.0 2016-03-23 16:07:17 -04:00
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2020-05-10 22:39:06 +02:00
Gemfile Use openstack_spec_helper from zuul checkout 2020-08-30 22:57:25 +02:00
LICENSE Update LICENSE 2018-04-06 20:14:30 +08:00
metadata.json Prepare Yoga RC1 2022-03-11 22:20:10 +09:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:20 -05:00
README.md Add Puppet Litmus 2020-08-31 21:25:18 +02:00
setup.cfg Add information technology in the setup.cfg 2021-10-01 06:54:49 +08:00
setup.py setuptools: Disable auto discovery 2022-03-29 10:38:58 +02:00
tox.ini Stop configuring install_command in tox. 2021-09-30 09:45:26 +09:00

Team and repository tags

Team and repository tags

horizon

Table of Contents

  1. Overview - What is the horizon module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with horizon
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Release Notes - Release notes for the project
  8. Contributors - Those with commits
  9. 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