Horizon: The OpenStack Dashboard Project

Introduction

Horizon is the canonical implementation of OpenStack’s Dashboard, which provides a web based user interface to OpenStack services including Nova, Swift, Keystone, etc.

For a more in-depth look at Horizon and its architecture, see the Introduction to Horizon.

To learn what you need to know to get going, see the Quickstart.

Using Horizon

How to use Horizon in your own projects.

• Installing Horizon
• Deploying Horizon
• Settings and Configuration
• Customizing Horizon

Developer Docs

For those wishing to develop Horizon itself, or go in-depth with building your own Dashboard or Panel classes, the following documentation is provided.

General information

Brief guides to areas of interest and importance when developing Horizon.

• Horizon Basics
• Quickstart
• Tutorial: Building a Dashboard using Horizon
• Contributing Guide
• Horizon’s tests and you
• Horizon Plugin Registry

Topic Guides

Information on how to work with specific areas of Horizon can be found in the following topic guides.

• Workflows Topic Guide
• DataTables Topic Guide
• Horizon Policy Enforcement (RBAC: Role Based Access Control)
• Testing Topic Guide
• Tutorial: Adding a complex action to a table
• AngularJS Topic Guide
• JavaScript Testing

API Reference

In-depth documentation for Horizon and its APIs.

• The run_tests.sh Script
• The horizon Module
• Horizon Workflows
• Horizon DataTables
• Horizon Tabs and TabGroups
• Horizon Forms
• Horizon Middleware
• Horizon Context Processors
• Horizon Decorators
• Horizon Exceptions
• Horizon TestCase Classes
• local.conf

Source Code Reference

Auto-generated reference for the complete source code.

• Source Code Index

Release Notes

• Horizon 2012.1 “Essex”
• Horizon 2012.2 “Folsom”
• Horizon 2013.1 “Grizzly”
• Horizon 2013.2 “Havana”
• Horizon 2014.1 “Icehouse”
• Horizon 2014.2 “Juno”

Information

• Frequently Asked Questions
• Glossary

• Index
• Module Index