Skip to content

Commit

Permalink
chore: lint
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelThamm committed Nov 18, 2024
1 parent 04fc3ce commit 9e4c546
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions sos/report/plugins/juju.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,26 @@


class Juju(Plugin, UbuntuPlugin):
"""The Juju plugin is aimed at collecting Juju-related logs,
"""The Juju plugin is aimed at collecting Juju-related logs,
configurations, and controller/model state(s).
Logs and agent configuration information (/var/log/juju and /var/lib/juju)
is collected by default since these are useful for troubleshooting.
The Juju state collection is disabled by default and can be enabled with the
'juju-state' option. Collecting Juju state is safe in theory, but it does act
on the live controller(s)/model(s) and is therefore optional.
The Juju state collection is disabled by default and can be enabled with
the 'juju-state' option. Collecting Juju state is safe in theory, but it
does act on the live controller(s)/model(s) and is therefore optional.
The default Juju state collection collects all controllers and models that the
'juju-user' (default=ubuntu) has access to.
The default Juju state collection collects all controllers and models that
the 'juju-user' (default=ubuntu) has access to.
Specific controllers or models can be collected using the 'controllers' and 'models' options.
Important: The string list is whitespace delimited, NOT colon delimited (sos plugin standard).
This is due to the underlying Juju CLI accepting specific models in the format 'controller:model' and
whitespaces are not allowed in either controller and model names.
Specific controllers or models can be collected using the 'controllers'
and 'models' options.
Important: the string list is whitespace delimited, not colon delimited
(sos plugin standard). This is due to the underlying Juju CLI accepting
specific models in the format 'controller:model' and whitespaces are not
allowed in either controller and model names.
Example: models="controller_a:model_x controller_b:model_y"
"""
Expand Down Expand Up @@ -61,13 +64,15 @@ class Juju(Plugin, UbuntuPlugin):
"controllers",
default="",
val_type=str,
desc="Collect Juju state for specified controllers. Uses a whitespace delimited list.",
desc="Collect Juju state for specified controllers. Uses a \
whitespace delimited list.",
),
PluginOpt(
"models",
default="",
val_type=str,
desc="Collect Juju state for specified models. Uses a whitespace delimited list.",
desc="Collect Juju state for specified models. Uses a whitespace \
delimited list.",
),
]

Expand Down

0 comments on commit 9e4c546

Please sign in to comment.