Skip to content

Commit 4dfde64

Browse files
committed
Update documentation
1 parent 3f97d11 commit 4dfde64

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

doc/source/configuration.rst

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,32 @@ Otherwise, ``cASO`` will not be able to get the usages and will fail.
3434
In order to do so, we are going to setup a new role ``accounting`` a new user
3535
``accounting``, adding it to each of the projects with that role::
3636

37-
openstack role create accounting
3837
openstack user create --password <password> accounting
3938
# For each of the projects, add the user with the accounting role
40-
openstack role add --user accounting --project <project> accounting
39+
openstack role add --user accounting --project <project> reader
40+
41+
Moreover, if you wish to gather the list of projects that ``cASO`` should use directly
42+
from OpenStack, you need to grant the user the role reader with a system scope of
43+
``all``::
44+
45+
openstack role add --system all --user accounting reader
4146

4247
Policy modifications
43-
--------------------
44-
The accounting user needs access to Keystone so as to extract the users
45-
information. In this case, we can can grant the user just the rights for
46-
listing the users adding the appropriate rules in your policy configuration.
48+
------------------------
49+
50+
.. important:: No policy modifications are needed
51+
52+
The following policy modifications are just shown here for reference, if you wish to
53+
use a different role. You do not need to use them.
54+
55+
If you use the role ``reader`` as configured above, you do not need to configure
56+
anything else in the policy. However, if you wish to use a different role mapping, the
57+
accounting user needs access to Keystone so as to extract the users information.
4758
Depending on your configuration, you need to modify the JSON policy file
4859
(``/etc/keystone/policy.json``) or the YAML policy file (``/etc/keystone/policy-yaml``).
49-
The modifications in the policy depend on the Keystone version, please ensure
50-
that you are applying the correct changes as listed in the following table.
60+
The modifications in the policy depend on the Keystone version, please ensure that you
61+
are applying the correct changes as listed in the following table. In the example show,
62+
we are using a dedicated role ``accounting``.
5163

5264
+-------------+------------------------------------------------------------------------------+
5365
| OpenStack | Policy contents |
@@ -95,7 +107,7 @@ to specify the correct mapping in each of the projects properties. The name of t
95107
property that will be used is defined in the ``vo_property`` configuration option, and
96108
defaults to ``accounting:VO``, therefore you can configure it as follows::
97109

98-
openstack project set --property acconting:VO=<VO FQAN> <project id>
110+
openstack project set --property accounting:VO=<VO FQAN> <project id>
99111

100112
cASO configuration
101113
==================

releasenotes/notes/tags-for-projects-3b9b6b5a92bcc6df.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@
22
features:
33
- |
44
Allow to use Keystone project tags to get usages from projects.
5+
upgrade:
6+
- |
7+
If using tags to gather the list of projects you need to ensure that the
8+
correct roles and system scopes are applied. Please ensure that the correct
9+
roles are defined, as indicated in the configuration documentation.

0 commit comments

Comments
 (0)