2011-10-31 18:31:05 +00:00
|
|
|
..
|
2013-09-19 18:49:55 +00:00
|
|
|
Copyright 2012 OpenStack Foundation
|
2011-10-31 18:31:05 +00:00
|
|
|
All Rights Reserved.
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
not use this file except in compliance with the License. You may obtain
|
|
|
|
a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
License for the specific language governing permissions and limitations
|
|
|
|
under the License.
|
|
|
|
|
|
|
|
========================================
|
|
|
|
Horizon: The OpenStack Dashboard Project
|
|
|
|
========================================
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
============
|
|
|
|
|
2014-02-17 05:34:11 +00:00
|
|
|
Horizon is the canonical implementation of `OpenStack's Dashboard
|
2011-10-31 18:31:05 +00:00
|
|
|
<https://github.com/openstack/horizon>`_, which provides a web based user
|
|
|
|
interface to OpenStack services including Nova, Swift, Keystone, etc.
|
|
|
|
|
2012-01-12 23:10:21 +00:00
|
|
|
For a more in-depth look at Horizon and its architecture, see the
|
2011-10-31 18:31:05 +00:00
|
|
|
:doc:`Introduction to Horizon <intro>`.
|
|
|
|
|
|
|
|
To learn what you need to know to get going, see the :doc:`quickstart`.
|
|
|
|
|
2014-10-04 21:53:38 +00:00
|
|
|
Using Horizon
|
|
|
|
=============
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
How to use Horizon in your own projects.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2014-10-04 21:53:38 +00:00
|
|
|
topics/install
|
2012-02-29 02:52:06 +00:00
|
|
|
topics/deployment
|
2013-03-17 23:07:37 +00:00
|
|
|
topics/settings
|
2012-03-14 03:35:23 +00:00
|
|
|
topics/customizing
|
2015-09-28 09:28:28 +00:00
|
|
|
topics/packaging
|
2011-10-31 18:31:05 +00:00
|
|
|
|
2012-02-12 02:44:39 +00:00
|
|
|
Developer Docs
|
|
|
|
==============
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
For those wishing to develop Horizon itself, or go in-depth with building
|
|
|
|
your own :class:`~horizon.Dashboard` or :class:`~horizon.Panel` classes,
|
|
|
|
the following documentation is provided.
|
|
|
|
|
2012-02-12 02:44:39 +00:00
|
|
|
General information
|
|
|
|
-------------------
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
Brief guides to areas of interest and importance when developing Horizon.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2014-10-04 21:53:38 +00:00
|
|
|
intro
|
|
|
|
quickstart
|
2012-01-20 07:07:46 +00:00
|
|
|
contributing
|
2011-10-31 18:31:05 +00:00
|
|
|
testing
|
2016-01-25 20:32:39 +00:00
|
|
|
plugin_registry
|
|
|
|
|
|
|
|
Tutorials
|
|
|
|
---------
|
|
|
|
|
|
|
|
Detailed tutorials to help you get started.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
tutorials/plugin
|
|
|
|
tutorials/dashboard
|
2011-10-31 18:31:05 +00:00
|
|
|
|
2012-02-12 02:44:39 +00:00
|
|
|
Topic Guides
|
|
|
|
------------
|
|
|
|
|
|
|
|
Information on how to work with specific areas of Horizon can be found in
|
|
|
|
the following topic guides.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2013-08-15 09:26:19 +00:00
|
|
|
topics/workflows
|
2012-02-12 02:44:39 +00:00
|
|
|
topics/tables
|
Adding RBAC policy system and checks for identity
Adding file based RBAC engine for Horizon using copies of nova and
keystone policy.json files
Policy engine builds on top of oslo incubator policy.py, fileutils
was also pulled from oslo incubator as a dependency of policy.py
When Horizon runs and a policy check is made, a path and mapping of
services to policy files is used to load the rules into the policy
engine. Each check is mapped to a service type and validated. This
extra level of mapping is required because the policy.json files
may each contain a 'default' rule or unqualified (no service name
include) rule. Additionally, maintaining separate policy.json
files per service will allow easier syncing with the service
projects.
The engine allows for compound 'and' checks at this time. E.g.,
the way the Create User action is written, multiple APIs are
called to read data (roles, projects) and more are required to
update data (grants, user).
Other workflows e.g., Edit Project, should have separate save
actions per step as they are unrelated. Only the applicable
policy checks to that step were added. The separating unrelated
steps saves will should be future work.
The underlying engine supports more rule types that are used in the
underlying policy.json files.
Policy checks were added for all actions on tables in the Identity
Panel only. And the service policy files imported are limited in
this commit to reduce scope of the change.
Additionally, changes were made to the base action class to add
support or setting policy rules and an overridable method for
determining the policy check target. This reduces the need for
redundant code in each action policy check.
Note, the benefit Horizon has is that the underlying APIs will
correct us if we get it wrong, so if a policy file is not found for
a particular service, permission is assumed and the actual API call
to the service will fail if the action isn't authorized for that user.
Finally, adding documentation regarding policy enforcement.
Implements: blueprint rbac
Change-Id: I4a4a71163186b973229a0461b165c16936bc10e5
2013-08-16 23:28:46 +00:00
|
|
|
topics/policy
|
2012-02-12 02:44:39 +00:00
|
|
|
topics/testing
|
2015-01-07 23:28:54 +00:00
|
|
|
topics/table_actions
|
2015-05-11 07:28:57 +00:00
|
|
|
topics/angularjs
|
|
|
|
topics/javascript_testing
|
2015-11-10 15:04:05 +00:00
|
|
|
topics/styling
|
2012-02-12 02:44:39 +00:00
|
|
|
|
2011-10-31 18:31:05 +00:00
|
|
|
API Reference
|
|
|
|
-------------
|
|
|
|
|
2012-04-05 18:35:15 +00:00
|
|
|
In-depth documentation for Horizon and its APIs.
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
ref/run_tests
|
|
|
|
ref/horizon
|
2012-05-13 20:25:38 +00:00
|
|
|
ref/workflows
|
2011-12-28 03:40:49 +00:00
|
|
|
ref/tables
|
2012-02-27 23:40:07 +00:00
|
|
|
ref/tabs
|
2011-10-31 18:31:05 +00:00
|
|
|
ref/forms
|
|
|
|
ref/middleware
|
|
|
|
ref/context_processors
|
|
|
|
ref/decorators
|
|
|
|
ref/exceptions
|
2012-02-12 02:44:39 +00:00
|
|
|
ref/test
|
2014-08-21 22:10:13 +00:00
|
|
|
ref/local_conf
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
Source Code Reference
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
Auto-generated reference for the complete source code.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
sourcecode/autoindex
|
|
|
|
|
2012-04-05 01:31:52 +00:00
|
|
|
Release Notes
|
|
|
|
=============
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:glob:
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
releases/*
|
2011-10-31 18:31:05 +00:00
|
|
|
|
|
|
|
Information
|
|
|
|
===========
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
faq
|
|
|
|
glossary
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
* :ref:`modindex`
|