Skip to content

Commit

Permalink
[manpages|policies] Update location of presets and collect groups
Browse files Browse the repository at this point in the history
Continue changes started in #3829 from /var/lib to /etc/sos

Related: #3829, #3826

Signed-off-by: Jose Castillo <[email protected]>
  • Loading branch information
jcastill authored and TurboTurtle committed Nov 4, 2024
1 parent f43d0a0 commit a3d5b1f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions man/en/sos-collect.1
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,15 @@ rather than key-pair encryption.
Specify an existing host group definition to use.

Host groups are pre-defined settings for the cluster-type, primary node, and nodes options
saved in JSON-formatted files under /var/lib/sos collect/<GROUP>.
saved in JSON-formatted files under /etc/sos/groups.d/<GROUP>.

If cluster_type and/or primary are set in the group, sos collect behaves as if
these values were specified on the command-line.

If nodes is defined, sos collect \fBextends\fR the \fB\-\-nodes\fR option, if set,
with the nodes or regexes listed in the group.

Note that sos collect will only write group definitions to /var/lib/sos collect/
Note that sos collect will only write group definitions to /etc/sos/groups.d/
however the GROUP value may be a filename for any group definitions that exist outside
of the default location. If you are manually writing these files, use the value \fBnull\fR
when a python NoneType is expected. Caveat: use \fBstring\fR 'none' if setting cluster_type
Expand All @@ -178,7 +178,7 @@ to none.
\fB\-\-save\-group\fR GROUP
Save the results of this run of sos collect to a host group definition.

sos-collector will write a JSON-formatted file with name GROUP to /var/lib/sos collect/
sos-collector will write a JSON-formatted file with name GROUP to /etc/sos/groups.d/
with the settings for cluster-type, primary, and the node list as discovered by cluster enumeration.
Note that this means regexes are not directly saved to host groups, but the results of matching against
those regexes are.
Expand Down
2 changes: 1 addition & 1 deletion sos/policies/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ def load_presets(self, presets_path=None):
"""Load presets from disk.
Read JSON formatted preset data from the specified path,
or the default location at ``/var/lib/sos/presets``.
or the default location at ``/etc/sos/presets.d``.
:param presets_path: a directory containing JSON presets.
"""
Expand Down

0 comments on commit a3d5b1f

Please sign in to comment.