Local publisher plugin¶
This publisher plugin uploads reports and attachments to a directory, which may be mounted.
It is disabled by default as it requires you to define a target directory. Please refer to “Instance configuration” for more information on how to enable or disable a plugin.
It exposes no user-facing endpoints.
There is one service-specific configuration file option that must be specified.
You can set the
LOCALPUBLISHER_DEBUG_LEVEL (all upper-cased) or
DEBUG_LEVEL environment variables
DEBUG to add additional information in the console for the launched service. It defaults to
INFO. (Please note that setting
DEBUG will produce tons of logs.)
The possible values are
FATAL. Those values
are from the most verbose,
NOTSET, which shows all logs, to the least verbose,
only shows fatal errors.
LOCALPUBLISHER_DEBUG_LEVEL is not defined then the value of
DEBUG_LEVEL is used (or
DEBUG_LEVEL is not defined either).
Access logs are only shown at
This plugin has a configuration file (
localpublisher.yaml by default) that describes
the common service configuration options.
If no configuration file is found it will default to the following values:
apiVersion: opentestfactory.org/v1beta2 kind: ServiceConfig current-context: default contexts: - name: default context: port: 443 host: 127.0.0.1 ssl_context: adhoc eventbus: endpoint: https://127.0.0.1:38368 token: invalid-token target: /app/data
The configuration included in the ‘allinone’ image is described in “Common settings.” The
listening port is 7783 and the bind address is
127.0.0.1 as the service exposes no user-facing endpoints.
There is one service-specific configuration option besides the common ones that must be specified, target.
target entry in the context specifies a target directory. Attachments will be
stored in this directory, under a
This directory is typically a mount point, linked to an external volume.
The local publisher plugin subscribes to the following events:
The local publisher plugin exposes an
/inbox endpoint that is used by the event bus to post relevant events.
If you want to manually start the local publisher plugin, use the following command:
python -m opentf.plugins.localpublisher.main [--context context] [--config configfile]
Additional command-line options are available and described in “Command-line options.”