Fixed sphinx ERRORs.
Fixed errors and warnings due to formatting and layout errors in documentation. Those errors makes the page be empty or unavailable. Other layouts/format fixes makes documentation more clear. Removed rpc/common.py from patch as suggested in code review. Change-Id: I0fe11f66384f1aa8919bbb3f5cdf5339f0cbdfc6 Partial-Bug:1257725
This commit is contained in:
parent
9942527626
commit
1880fd63aa
|
@ -257,6 +257,7 @@ parse the data. The updating process is fully encapsulated into table
|
||||||
functionality, communication with the server goes through AJAX in JSON format.
|
functionality, communication with the server goes through AJAX in JSON format.
|
||||||
The javacript wrapper for inline editing allows each table cell that has
|
The javacript wrapper for inline editing allows each table cell that has
|
||||||
in-line editing available to:
|
in-line editing available to:
|
||||||
|
|
||||||
#. Refresh itself with new data from the server.
|
#. Refresh itself with new data from the server.
|
||||||
#. Display in edit mod.
|
#. Display in edit mod.
|
||||||
#. Send changed data to server.
|
#. Send changed data to server.
|
||||||
|
|
|
@ -371,6 +371,7 @@ class Dashboard(Registry, HorizonComponent):
|
||||||
|
|
||||||
Boolean value to determine whether this dashboard can be viewed
|
Boolean value to determine whether this dashboard can be viewed
|
||||||
without being logged in. Defaults to ``False``.
|
without being logged in. Defaults to ``False``.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
_registerable_class = Panel
|
_registerable_class = Panel
|
||||||
name = ''
|
name = ''
|
||||||
|
|
|
@ -129,26 +129,29 @@ class SecurityGroupManager(object):
|
||||||
|
|
||||||
SecurityGroup object returned from methods in this class
|
SecurityGroup object returned from methods in this class
|
||||||
must contains the following attributes:
|
must contains the following attributes:
|
||||||
- id : ID of Security Group (int for Nova, uuid for Neutron)
|
|
||||||
- name
|
|
||||||
- description
|
|
||||||
- tenant_id
|
|
||||||
- rules : A list of SecurityGroupRule objects
|
|
||||||
|
|
||||||
SecurityGroupRule object should have the following attributes:
|
* id: ID of Security Group (int for Nova, uuid for Neutron)
|
||||||
The attribute names and their formats are borrowed from nova
|
* name
|
||||||
security group implementation.
|
* description
|
||||||
- id
|
* tenant_id
|
||||||
- direction
|
* rules: A list of SecurityGroupRule objects
|
||||||
- ethertype
|
|
||||||
- parent_group_id : security group the rule belongs to
|
SecurityGroupRule object should have the following attributes
|
||||||
- ip_protocol
|
(The attribute names and their formats are borrowed from nova
|
||||||
- from_port : lower limit of allowed port range (inclusive)
|
security group implementation):
|
||||||
- to_port : upper limit of allowed port range (inclusive)
|
|
||||||
- ip_range : remote IP CIDR (source for ingress, dest for egress)
|
* id
|
||||||
The value should be a format of "{'cidr': <cidr>}"
|
* direction
|
||||||
- group : remote security group
|
* ethertype
|
||||||
The value should be a format of "{'name': <secgroup_name>}"
|
* parent_group_id: security group the rule belongs to
|
||||||
|
* ip_protocol
|
||||||
|
* from_port: lower limit of allowed port range (inclusive)
|
||||||
|
* to_port: upper limit of allowed port range (inclusive)
|
||||||
|
* ip_range: remote IP CIDR (source for ingress, dest for egress).
|
||||||
|
The value should be a format of "{'cidr': <cidr>}"
|
||||||
|
* group: remote security group. The value should be a format of
|
||||||
|
"{'name': <secgroup_name>}"
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
__metaclass__ = abc.ABCMeta
|
__metaclass__ = abc.ABCMeta
|
||||||
|
|
|
@ -22,9 +22,9 @@ def get_available_images(request, project_id=None, images_cache=None):
|
||||||
project_id. If project_id is not specified, only public images
|
project_id. If project_id is not specified, only public images
|
||||||
are returned.
|
are returned.
|
||||||
|
|
||||||
:param images_cache:
|
:param images_cache: An optional dict-like object in which to
|
||||||
An optional dict-like object in which to
|
cache public and per-project id image metadata.
|
||||||
cache public and per-project id image metadata.
|
|
||||||
"""
|
"""
|
||||||
if images_cache is None:
|
if images_cache is None:
|
||||||
images_cache = {}
|
images_cache = {}
|
||||||
|
|
|
@ -65,22 +65,28 @@ def check(actions, request, target={}):
|
||||||
Check if the user has permission to the action according
|
Check if the user has permission to the action according
|
||||||
to policy setting.
|
to policy setting.
|
||||||
|
|
||||||
:param actions: list of scope and action to do policy checks on, the
|
:param actions: list of scope and action to do policy checks on,
|
||||||
composition of which is (scope, action)
|
the composition of which is (scope, action)
|
||||||
|
|
||||||
scope: service type managing the policy for action
|
* scope: service type managing the policy for action
|
||||||
action: string representing the action to be checked
|
|
||||||
|
* action: string representing the action to be checked
|
||||||
|
|
||||||
this should be colon separated for clarity.
|
this should be colon separated for clarity.
|
||||||
i.e. compute:create_instance
|
i.e.
|
||||||
compute:attach_volume
|
|
||||||
volume:attach_volume
|
|
||||||
|
|
||||||
for a policy action that requires a single action:
|
| compute:create_instance
|
||||||
actions should look like "(("compute", "compute:create_instance"),)"
|
| compute:attach_volume
|
||||||
for a multiple action check:
|
| volume:attach_volume
|
||||||
actions should look like "(("identity", "identity:list_users"),
|
|
||||||
("identity", "identity:list_roles"))"
|
for a policy action that requires a single action, actions
|
||||||
|
should look like
|
||||||
|
|
||||||
|
| "(("compute", "compute:create_instance"),)"
|
||||||
|
|
||||||
|
for a multiple action check, actions should look like
|
||||||
|
| "(("identity", "identity:list_users"),
|
||||||
|
| ("identity", "identity:list_roles"))"
|
||||||
|
|
||||||
:param request: django http request object. If not specified, credentials
|
:param request: django http request object. If not specified, credentials
|
||||||
must be passed.
|
must be passed.
|
||||||
|
|
|
@ -63,12 +63,12 @@ def update_dashboards(modules, horizon_config, installed_apps):
|
||||||
|
|
||||||
For example, given this setup:
|
For example, given this setup:
|
||||||
|
|
||||||
foo/__init__.py
|
| foo/__init__.py
|
||||||
foo/_10_baz.py
|
| foo/_10_baz.py
|
||||||
foo/_20_qux.py
|
| foo/_20_qux.py
|
||||||
|
|
||||||
bar/__init__.py
|
| bar/__init__.py
|
||||||
bar/_30_baz_.py
|
| bar/_30_baz_.py
|
||||||
|
|
||||||
and being called with ``modules=[foo, bar]``, we will first have the
|
and being called with ``modules=[foo, bar]``, we will first have the
|
||||||
configuration from ``_10_baz`` and ``_30_baz`` merged, then the
|
configuration from ``_10_baz`` and ``_30_baz`` merged, then the
|
||||||
|
|
Loading…
Reference in New Issue