Agent channel service¶
This channel plugin manages communications with execution environments that are accessed via agents.
It exposes user-facing endpoints that are used by agents.
There are no service-specific configuration file options.
You can set the
AGENTCHANNEL_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.
AGENTCHANNEL_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
AGENTCHANNEL_CHANNEL_HOOKS environment variable, if defined, must refer to an
existing file that contains hook definitions.
For more information about hooks, see “Hooks for jobs and providers.”
If the content of this referred file changes, the hooks definitions used by the channel handler will change accordingly. You do not need to restart the provider plugin.
This plugin has a configuration file (
agentchannel.yaml by default) that describes the
host, port, ssl_context, and trusted_authorities to use. It can also enable insecure
If no configuration file is found it will default to the following values:
The configuration included in the ‘allinone’ image is described in “Common settings.” The
listening port is
24368 and the bind address is
0.0.0.0 as the service exposes user-facing endpoints.
There are no service-specific configuration options besides the common ones.
The agent channel plugin subscribes to the following events:
The agent channel plugin exposes an
/inbox endpoint that is used by the event bus to post relevant events.
If you want to manually start the agent channel plugin, use the following command:
python -m opentf.plugins.agentchannel.main [--context context] [--config configfile]
Additional command-line options are available and described in “Command-line options.”