Skip to content

Commit 3dcc4ad

Browse files
committed
Update and fix various issues in documentation
1 parent 4222484 commit 3dcc4ad

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

doc/source/configuration.rst

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,12 @@ OpenStack installation in order to be able to extract accounting records.
2525
User credentials (required)
2626
---------------------------
2727

28-
In the next section you will configure an OpenStack Keystone credentials in
29-
order to extract the records. The cASO user has to be a member of each of the
30-
projects (another option is to convert that user in an administrator, but the
31-
former option is a safer approach) for which it is extracting the accounting.
32-
Otherwise, ``cASO`` will not be able to get the usages and will fail.
33-
34-
In order to do so, we are going to setup a new role ``accounting`` a new user
35-
``accounting``, adding it to each of the projects with that role::
28+
In the next section you will configure an OpenStack Keystone credentials in order to
29+
extract the records. The cASO user has to be a member of each of the projects (another
30+
option is to convert that user in an administrator, but the former option is a safer
31+
approach) for which it is extracting the accounting, with the ``reader`` role (this is
32+
a default OpenStack Keystone role). Otherwise, ``cASO`` will not be able to get the
33+
usages and will fail::
3634

3735
openstack user create --password <password> accounting
3836
# For each of the projects, add the user with the accounting role
@@ -136,21 +134,24 @@ of every option. You should check at least the following options:
136134
domain-based authentication, as otherwise gathering the information might
137135
fail. This option, and the usage of ``caso_tag`` below will set up the final
138136
project list.
139-
* ``caso_tag`` (default value: ``caso``), specified the tag to be used filter
140-
projects to extract their usage. The projects that are listed with this tag,
141-
as well as the ``projects`` list set above will set up the final project list.
137+
* ``caso_tag`` (default value: ``caso``), specified the tag to be used filter projects
138+
to extract their usage. The projects that are listed with this tag, as well as the
139+
``projects`` list set above will set up the final project list. If you only use tags,
140+
and want to remove a project from being published, you just need to remove the tag
141+
from the project.
142142
* ``messengers`` (list, default: ``noop``). List of the messengers to publish
143143
data to. Records will be pushed to all these messengers, in order. Valid
144144
messengers shipped with cASO are:
145145

146-
* ``ssm`` for publishing APEL V0.2 records (deprecated).
147-
* ``ssmv2`` for publishing APEL V0.2 records (deprecated).
148-
* ``ssmv4`` for publishing APEL V0.3 records (current).
146+
* ``ssm`` for publishing APEL records.
149147
* ``logstash`` for publishing to Logstash.
150148
* ``noop`` do nothing at all.
151149

152150
Note that there might be other messengers available in the system if they are
153-
registered into the ``caso.messenger`` entry point namespace.
151+
registered into the ``caso.messenger`` entry point namespace. Please also note that
152+
versioning of the SSM messenger is deprecated.
153+
* ``vo_property`` (default: ``accounting:VO``). The project that will be set in the
154+
OpenStack Keystone project to map a given project to a specific VO.
154155
* **DEPRECATED** ``mapping_file`` (default: ``/etc/caso/voms.json``). File containing
155156
the mapping from VOs to local projects as configured in Keystone-VOMS, in the
156157
following form::
@@ -164,10 +165,6 @@ of every option. You should check at least the following options:
164165
Note that you have to use either the project ID or project name for the
165166
mapping, as configured in the ``projects`` configuration variable.
166167

167-
* ``benchmark_name_key`` and ``benchmark_value_key``. These two configuration
168-
options are used by ``cASO`` to retrieve the benchmark information form the
169-
OpenStack flavors.
170-
171168
``[keystone_auth]`` section
172169
---------------------------
173170

0 commit comments

Comments
 (0)