Commit Graph

20 Commits

Author SHA1 Message Date
Thai Tran
15c7b03d06 Plugin Docs
Added tutorial folder for future tutorials.
Added tutorial for creating and installing plugins.
Moved dashboard tutorial into tutorial folder.

Change-Id: I17c1ff279b47292d723c100b580667418aa05636
Closes-Bug: #1511593
2016-01-25 12:33:27 -08:00
Jenkins
826c3ee39a Merge "Add dev docs for SCSS/and styling in Horizon" 2015-12-08 17:55:12 +00:00
Rob Cresswell
738cc34735 Add dev docs for SCSS/and styling in Horizon
This patch adds a topic guide explaining how developers should write and
organise SCSS within Horizon.

Change-Id: I4de2d1da73f6c7977a16fba9d09678923d7c443c
Closes-Bug: 1514869
2015-11-15 17:50:10 +00:00
Matthias Runge
e1b0502b3f adding general packaging information
This document is intended for horizon developers, adding
background on packaging topics. It even might be useful
for distribution packagers.

A few distributions are mentioned here, the list is neither complete
nor has been selected on purpose in that way.

Co-Authored-By: Thomas Goirand <thomas@goirand.fr>
Co-Authored-By: Andreas Jaeger <aj@suse.com>
Change-Id: If771636a086c384748f4cf34847d0a7a84a590ac
2015-11-10 11:58:59 +00:00
Rob Cresswell
0128ede253 Add plugin registry to docs
Currently, there is no list of plugins for Horizon. This patch adds an
initial list to the docs, which should be added to over time.

Change-Id: I5b00948886758e56770c0672c05b5e1d8fc81cc1
Closes-Bug: #1486080
2015-08-18 17:19:46 +01:00
Rob Cresswell
8d2792f19f AngularJS in Horizon Documentation
This patch is a first pass at reducing the levels of "tribal knowledge"
and making the AngularJS codebase more accessible. It details code
style, file structures, testing and translation.

Change-Id: I22e6e5627216739fc92a5c9a5b417c6c6b16476d
Closes-Bug: 1373310
2015-06-29 13:23:55 +01:00
Brian Fischer
6b7e9b3f53 Update to horizon tutorial.rst
Added documentation for addition of an action to a horizon table

DocImpact
Closes-Bug: #1360370
Change-Id: I0d3c5da5a860d777e21e61d36a5765c412911dba
2015-02-20 16:26:26 -08:00
Akihiro Motoki
aa0f0ebc18 Add install guide for users and clean up README
* Add "Using Horizon" section to the docs, which describes
  how to install and configure Horizon. It is for operators
  who install Horizon from source code.
* Clean up README.rst as much of the information is out-of-date
  and most of it is covered by the developer docs.
* Minor update of page titles.

Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-09 03:29:26 +09:00
David Lyle
38007b942e Amending the quickstart guide
*Updating to avoid use of manage.py directly.
*Making it more DevStack friendly.
*Adding a sample DevStack local.conf to allow for exercise Horizon
 against more services.
*Added simple developer instructions so new developers aren't tempted
 to work on the DevStack instance of Horizon.

Change-Id: I0840c63183e7cec3b08e4f2ce208479ff7552f60
2014-10-01 16:20:36 -06:00
tanlin
00ddad449a Rename Openstack to OpenStack
Change-Id: Ic9cf0ac67df03d9f044e93d0613f5d9379988417
2014-02-17 13:37:28 +08:00
David Lyle
bdfb56ae65 Cleaning up policy documentation
Change-Id: I125f6c81235c6a1519044dd6145636693530277c
Closes-bug: #1220778
2013-09-27 16:57:10 -06:00
ZhiQiang Fan
686cc88fd2 Replace OpenStack LLC with OpenStack Foundation
Change-Id: I6c638f04fb7c97ac986ef31c1190011ed90a43d2
Fixes-Bug: #1214176
2013-09-20 04:19:42 +08:00
Ladislav Smola
5df2055a17 Adding documentation to Tables and Workflows
Adding documentation of DataTable decorators.
Adding documentation and example of complex workflow.

Connecting topics with api reference.

Change-Id: I2653e0c5c52179dcc45cee689cde50afcd6ae0de
Fixes: bug #1212559
2013-09-12 11:59:03 +02:00
David Lyle
5984e34862 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-26 10:32:28 -06:00
Gabriel Hurley
ea96bb3a22 Adds docs for settings/configuration.
In addition to thoroughly documenting the settings and config
options for Horizon/OpenStack Dashboard, this clarifies some
misconceptions around how to enable Object Storage/Swift
and Netowrking/Quantum in the OpenStack Dashboard.

Fixes bug 1064412. DocImpact.

Change-Id: I85fc7592c55111f5bc69a7cdab49679eaf81c6ca
2013-03-17 16:16:51 -07:00
Gabriel Hurley
c339189b44 Auth refactor.
Switch to using the self-contained django_openstack_auth
package which is a proper django.contrib.auth pluggable
backend.

Notable functional improvements include:

  * Better overall security via use of standard Django
    auth code (well-vetted by security experts).
  * Token expiration checking.
  * User "enabled" attribute checking.
  * Support for full range of Django auth attributes
    such as is_anonymous, is_active, is_superuser, etc.
  * Improved hooks for RBAC/permission-based acess control.

Regarding the RBAC/permission-based access control, this
patch moves all "role" and "service"-oriented checks to
permission checks. This will make transitioning to
policy-driven checking much easier once that fully lands
in OpenStack.

Implements blueprint move-keystone-support-to-django-auth-backend

Change-Id: I4f3112af797aff8c4c5e9930c6ca33a70e45589d
2012-07-09 16:57:52 -07:00
Clark Boylan
f1a8e0c54f Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc and build results go in project/doc/build.

Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
2012-06-12 11:41:04 -07:00
Gabriel Hurley
9742842795 Re-architects the OpenStack Dashboard for modularity and extensibility.
Implements blueprint extensible-architecture.
Implements blueprint improve-dev-documentation.
Implements blueprint gettext-everywhere.
Implements blueprint sphinx-docs.

Complete re-architecture of the dashboard to transform it from a standalone django-openstack app to a Horizon framework for building dashboards. See the docs for more information.

Incidentally fixes the following bugs:

Fixes bug 845868 -- no PEP8 violations.
Fixes bug 766096 -- the dashboard can now be installed at any arbitrary URL.
Fixes bug 879111 -- tenant id is now controlled solely by the tenant switcher, not the url (which was disregarded anyway)
Fixes bug 794754 -- output of venv installation is considerably reduced.

Due to the scale and scope of this patch I recommend reviewing it on github: https://github.com/gabrielhurley/horizon/tree/extensible_architecture

Change-Id: I8e63f7ea235f904247df40c33cb66338d973df9e
2011-11-07 12:59:21 -08:00
Joe Heck
6e7d208436 adding version to project, setting up autobuild of docs with ./run_tests.sh --docs 2011-10-27 13:23:39 -07:00
Joe Heck
7fbd04358d adding developer docs 2011-10-27 13:23:39 -07:00