tweaking docs to fix link to wiki Keystone page
updated docstrings to remove two errors reformatted front page header to be consistent added links to autogenerated python documentation Change-Id: I59fddc12ff458bbd0102a40d4d85903ab6bd6394
This commit is contained in:
parent
126dd9c9bd
commit
c74009025f
@ -56,7 +56,7 @@ blueprint, or collaborate with others.
|
|||||||
|
|
||||||
`OpenStack Wiki <http://wiki.openstack.org/>`_
|
`OpenStack Wiki <http://wiki.openstack.org/>`_
|
||||||
|
|
||||||
* `useful keystone project links <http://wiki.openstack.org/keystone>`_
|
* `useful keystone project links <http://wiki.openstack.org/Keystone>`_
|
||||||
|
|
||||||
Keystone on Launchpad
|
Keystone on Launchpad
|
||||||
---------------------
|
---------------------
|
||||||
@ -68,6 +68,13 @@ code is hosted on GitHub
|
|||||||
* `Keystone Project Page on Launchpad <http://launchpad.net/keystone>`_
|
* `Keystone Project Page on Launchpad <http://launchpad.net/keystone>`_
|
||||||
* `Keystone Source Repository on GitHub <http://github.com/openstack/keystone>`_
|
* `Keystone Source Repository on GitHub <http://github.com/openstack/keystone>`_
|
||||||
|
|
||||||
|
Within launchpad, we use
|
||||||
|
`blueprints <https://blueprints.launchpad.net/keystone>`_, to track feature
|
||||||
|
work, and track `bugs <https://bugs.launchpad.net/keystone>`_ as well. If
|
||||||
|
you are looking for a place to get started contributing to keystone, please
|
||||||
|
look at any bugs for keystone that are tagged as `low-hanging-fruit
|
||||||
|
<https://bugs.launchpad.net/keystone/+bugs?field.tag=low-hanging-fruit>`_.
|
||||||
|
|
||||||
OpenStack Blog
|
OpenStack Blog
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ Getting Started
|
|||||||
community
|
community
|
||||||
|
|
||||||
Man Pages
|
Man Pages
|
||||||
---------
|
=========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
@ -72,7 +72,7 @@ Code Documentation
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
modules
|
api/autoindex
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
@ -129,6 +129,7 @@ def http_connect(ipaddr, port, device, partition, method, path,
|
|||||||
:param key_file Private key file (not needed if cert_file has private key)
|
:param key_file Private key file (not needed if cert_file has private key)
|
||||||
:param cert_file Certificate file (Keystore)
|
:param cert_file Certificate file (Keystore)
|
||||||
:returns: HTTPConnection object
|
:returns: HTTPConnection object
|
||||||
|
|
||||||
"""
|
"""
|
||||||
path = quote('/' + device + '/' + str(partition) + path)
|
path = quote('/' + device + '/' + str(partition) + path)
|
||||||
return http_connect_raw(ipaddr, port, device, partition, method, path,
|
return http_connect_raw(ipaddr, port, device, partition, method, path,
|
||||||
@ -153,6 +154,7 @@ def http_connect_raw(ipaddr, port, method, path, headers=None,
|
|||||||
:param key_file Private key file (not needed if cert_file has private key)
|
:param key_file Private key file (not needed if cert_file has private key)
|
||||||
:param cert_file Certificate file (Keystore)
|
:param cert_file Certificate file (Keystore)
|
||||||
:returns: HTTPConnection object
|
:returns: HTTPConnection object
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if ssl:
|
if ssl:
|
||||||
conn = HTTPSConnection('%s:%s' % (ipaddr, port), key_file=key_file,
|
conn = HTTPSConnection('%s:%s' % (ipaddr, port), key_file=key_file,
|
||||||
|
@ -79,20 +79,20 @@ def enforce(credentials, action, target):
|
|||||||
"""Verifies that the action is valid on the target in this context.
|
"""Verifies that the action is valid on the target in this context.
|
||||||
|
|
||||||
:param credentials: user credentials
|
:param credentials: user credentials
|
||||||
:param action: string representing the action to be checked
|
:param action: string representing the action to be checked, which
|
||||||
|
should be colon separated for clarity.
|
||||||
this should be colon separated for clarity.
|
|
||||||
i.e. compute:create_instance
|
|
||||||
compute:attach_volume
|
|
||||||
volume:attach_volume
|
|
||||||
|
|
||||||
:param target: dictionary representing the object of the action
|
:param target: dictionary representing the object of the action
|
||||||
for object creation this should be a dictionary
|
for object creation this should be a dictionary
|
||||||
representing the location of the object e.g.
|
representing the location of the object e.g.
|
||||||
{'tenant_id': object.tenant_id}
|
{'tenant_id': object.tenant_id}
|
||||||
|
|
||||||
:raises: `exception.Forbidden` if verification fails.
|
:raises: `exception.Forbidden` if verification fails.
|
||||||
|
|
||||||
|
Actions should be colon separated for clarity. For example:
|
||||||
|
|
||||||
|
* compute:create_instance
|
||||||
|
* compute:attach_volume
|
||||||
|
* volume:attach_volume
|
||||||
|
|
||||||
"""
|
"""
|
||||||
init()
|
init()
|
||||||
|
|
||||||
|
@ -56,9 +56,10 @@ class Driver(object):
|
|||||||
def token_to_key(self, token_id):
|
def token_to_key(self, token_id):
|
||||||
""" Converts PKI tokens to their short form used for keys in
|
""" Converts PKI tokens to their short form used for keys in
|
||||||
Database tables, memcached, and other lookup tables.
|
Database tables, memcached, and other lookup tables.
|
||||||
returns: if given a PKI token, returns its hashed value
|
|
||||||
Otherwise, returns the passed-in value if given a UUID or
|
:returns: if given a PKI token, returns its hashed value
|
||||||
hash of a token.
|
Otherwise, returns the passed-in value if given a UUID or
|
||||||
|
hash of a token.
|
||||||
"""
|
"""
|
||||||
return cms.cms_hash_token(token_id)
|
return cms.cms_hash_token(token_id)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user