Skip to content

Commit

Permalink
docs: add note to set_results about maximum size
Browse files Browse the repository at this point in the history
  • Loading branch information
benhoyt committed Oct 15, 2023
1 parent a88cd4f commit bb8f010
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions ops/charm.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ def set_results(self, results: Dict[str, Any]):
alphanumeric, and can only contain lowercase alphanumeric, hyphens
and periods.
Because results are passed to Juju using the command line, the maximum
size is around 100KB. However, actions results are designed to be
small: a few key-value pairs shown in the Juju CLI. If larger content
is needed, store it in a file and use something like ``juju scp``.
If any exceptions occur whilst the action is being handled, juju will
gather any stdout/stderr data (and the return code) and inject them into the
results object. Thus, the results object might contain the following keys,
Expand Down

0 comments on commit bb8f010

Please sign in to comment.