Skip to content

Commit 0097cc9

Browse files
committed
add doc8 validation
doc8 is similar to flake8, but for documentation: it's an opinionated style checker. https://github.com/stackforge/doc8 This patch also fixes two violations, regarding maximum line length and trailing whitespace. Change-Id: Icdbd360cea149f1af72243a59efedaed504ff336
1 parent 5bffb7a commit 0097cc9

8 files changed

+45
-40
lines changed

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ sphinx>=1.1.2,!=1.2.0,<1.3
77
testrepository>=0.0.18
88
testtools>=0.9.34
99
yasfb>=0.5.1
10+
doc8

specs/juno/audit-support-for-federation.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Audit Support for Keystone Federation
1212
<https://blueprints.launchpad.net/keystone/+spec/
1313
audit-support-for-federation>`_
1414

15-
Keystone is expanding its support for federated identity to enable it to have
16-
a more seamless integration into enterprise environments and to leverage
17-
existing identity providers. The extra complexity associated with authentication
18-
and authorization in federated Keystone deployments demands suitable audit
19-
support to ensure the OpenStack environment is used in a compliant fashion. In
20-
this blueprint we describe proposed auditing support for Keystone federated
21-
identity operations using the `DMTF Cloud Auditing Data Federation (CADF) Open
22-
Standard <http://www.dmtf.org/standards/cadf>`_, and leveraging `PyCADF
15+
Keystone is expanding its support for federated identity to enable it to have a
16+
more seamless integration into enterprise environments and to leverage existing
17+
identity providers. The extra complexity associated with authentication and
18+
authorization in federated Keystone deployments demands suitable audit support
19+
to ensure the OpenStack environment is used in a compliant fashion. In this
20+
blueprint we describe proposed auditing support for Keystone federated identity
21+
operations using the `DMTF Cloud Auditing Data Federation (CADF) Open Standard
22+
<http://www.dmtf.org/standards/cadf>`_, and leveraging `PyCADF
2323
<http://docs.openstack.org/developer/pycadf/>`_.
2424

2525
Problem Description

specs/juno/generic-mapping-federation.rst

+13-12
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Standardizing the federation process
1313

1414

1515
We propose that the federated authentication process be reengineered so that a
16-
user_id is returned alongside the identity attributes. In addition, the saml2.py
17-
authentication module should be renamed as mapped.py to denote that it applies
18-
to all authentication methods which require the asserted identity attributes to
19-
be mapped into local attributes.
16+
user_id is returned alongside the identity attributes. In addition, the
17+
saml2.py authentication module should be renamed as mapped.py to denote that it
18+
applies to all authentication methods which require the asserted identity
19+
attributes to be mapped into local attributes.
2020

2121

2222
Problem Description
@@ -25,9 +25,10 @@ Problem Description
2525
The existing federation logic uses `saml2` auth plugin to establish a local
2626
Keystone identity, by mapping trusted external identity attributes to local
2727
identity attributes. Now that other federation protocols will be supported by
28-
Keystone, it makes no sense to apply mapping via a saml2 plugin. Some federation
29-
authentication protocols already determine the ID of the user, this should be
30-
leveraged by the protocol specific sub modules and not the mapping engine.
28+
Keystone, it makes no sense to apply mapping via a saml2 plugin. Some
29+
federation authentication protocols already determine the ID of the user, this
30+
should be leveraged by the protocol specific sub modules and not the mapping
31+
engine.
3132

3233
Proposed Change
3334
===============
@@ -41,11 +42,11 @@ In order to resolve the problem the following changes should be made:
4142
#. The function for extracting attributes should return a user_id among the
4243
asserted attributes.
4344

44-
Splitting the logic of the Mapped plugin will allow subclassing of the plugin to
45-
handle protocols which provide attributes in a different way to mod_shib, while
46-
still enabling reuse of the mapping filter implementation. We can then use the
47-
correct method name according to the protocol used so that clients can easily
48-
determine their behaviour.
45+
Splitting the logic of the Mapped plugin will allow subclassing of the plugin
46+
to handle protocols which provide attributes in a different way to mod_shib,
47+
while still enabling reuse of the mapping filter implementation. We can then
48+
use the correct method name according to the protocol used so that clients can
49+
easily determine their behaviour.
4950

5051
For instance, a configuration for a SAML2 and an Open ID Connect enabled
5152
Keystone might look like: ::

specs/juno/hierarchical_multitenancy.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,12 @@ Proposed Change
128128
* Example:
129129

130130
* The domain_admin_team creates the Dev and Test projects and assigns the
131-
role ``project_admin`` to project_admin_user. As their role is inheritable
132-
it will have access to their children.
131+
role ``project_admin`` to project_admin_user. As their role is
132+
inheritable it will have access to their children.
133133

134-
* As Joe has ``project_admin`` role assignment in Dev project, he can create
135-
instances in this project and can create subproject and control quotas
136-
to his subprojects. The same thing will happen to Sam in Test.
134+
* As Joe has ``project_admin`` role assignment in Dev project, he can
135+
create instances in this project and can create subproject and control
136+
quotas to his subprojects. The same thing will happen to Sam in Test.
137137

138138
* The user_project_admin can grant/revoke roles to users in its project
139139
and in its subprojects. A user with a member role can't grant/revoke
@@ -239,8 +239,8 @@ Work Items
239239
have to implement the following functions: (This change will be made in
240240
extension OS-INHERIT)
241241

242-
* A role assignment defined for a project A must be inherited by all the child
243-
projects of project A;
242+
* A role assignment defined for a project A must be inherited by all the
243+
child projects of project A;
244244
* A role assignment defined for a group X must be inherited by all the child
245245
projects of that group X;
246246
* For a project A, list all the inherited roles assignment of A, which will

specs/juno/keystone-to-keystone-federation.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -335,9 +335,9 @@ Performance Impact
335335
The following operations may impact performance:
336336

337337
* Since there could be as many service providers as regions, the catalog may
338-
become larger. However this limitation exists today as a catalog can have many
339-
endpoints and also become pretty large with the endpoints that a user has
340-
access to.
338+
become larger. However this limitation exists today as a catalog can have
339+
many endpoints and also become pretty large with the endpoints that a user
340+
has access to.
341341

342342
* More certificates to validate tokens against.
343343

specs/juno/multi-backend-uuids.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,8 @@ The two main impacts on a deployer will be:
328328
This will purge all mappings
329329
- ``keystone-manage mapping_purge --domain-name <name>``--
330330
This will purge all mappings for the named domain
331-
- ``keystone-manage mapping_purge --domain-name <name> --local-id <ID> --type <user|group>``--
331+
- ``keystone-manage mapping_purge --domain-name <name> --local-id <ID> --type
332+
<user|group>``--
332333
This will purge the mapping for the named local identifier
333334
- ``keystone-manage mapping_purge --public-id <ID>``--
334335
This will purge the mapping for the named public ID

specs/keystonemiddleware/implemented/split-middleware-repo.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -138,16 +138,16 @@ Work Items
138138

139139
* Create new repo.
140140

141-
* Copy middleware code and tests from python-keystoneclient to new repo using the
142-
oslo-incubator graduation utilities to maintain the change history.
141+
* Copy middleware code and tests from python-keystoneclient to new repo using
142+
the oslo-incubator graduation utilities to maintain the change history.
143143

144-
* Copy middleware (used by external services (e.g. ec2token)) code and tests from
145-
keystone to the new repo using the oslo-incubator graduation utilities to
146-
maintain the change history.
144+
* Copy middleware (used by external services (e.g. ec2token)) code and tests
145+
from keystone to the new repo using the oslo-incubator graduation utilities
146+
to maintain the change history.
147147

148-
* Change keystoneclient and Keystone middleware so that it prints out a deprecated
149-
message if it's used. This includes updating any deprecation messages to point
150-
to the new package.
148+
* Change keystoneclient and Keystone middleware so that it prints out a
149+
deprecated message if it's used. This includes updating any deprecation
150+
messages to point to the new package.
151151

152152
* Release an initial version of the keystonemiddleware package (to be performed
153153
before deprecation updates).

tox.ini

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ usedevelop = True
88
setenv = VIRTUAL_ENV={envdir}
99
install_command = pip install -U {opts} {packages}
1010
deps = -r{toxinidir}/requirements.txt
11-
commands = python setup.py testr --slowest --testr-args='{posargs}'
11+
commands =
12+
python setup.py testr --slowest --testr-args='{posargs}'
13+
doc8 specs/
1214

1315
[testenv:venv]
1416
commands = {posargs}

0 commit comments

Comments
 (0)