While not strictly necessary for communication over stdin/stdout, the message length makes it easy to delineate message boundaries. Note that this should be overrideable, as specified in the config-file argument mentioned above.Įach message has a 4-byte big-endian message length indicating the length of the message to be read, followed by the message payload. If the default file should be used, this argument will not be present.Įach plugin should also allow for configuration overrides of these values and any additional necessary configuration via file, located at /etc/rstudio/nf.
This should override any default configuration file provided by the plugin. Path to the configuration file for this plugin (user-specified). For more information, see the subsequent section on heartbeat messages. If the plugin misses 3 heartbeats in a row, the Job Launcher considers it to be in an invalid state and will kill and restart the plugin. If this is 0, then heartbeats should be disabled. The number of seconds in between heartbeats. This is where the plugin may store temporary data, such as cached information about jobs. The path assigned by the Job Launcher that the plugin is allowed to write to. If so, a higher level of verbosity should be used when logging information.
#MAXX CLASTER VST SOFTWARE#
Plugins start with root privilege to allow for user impersonation when communicating with cluster software that requires it.Ī 0 or 1 indicating whether or not debug logging should be enabled. Plugins start with root privilege and SHOULD lower their privilege to run as the user specified by this argument. The name of the user that the process should be run as. The following configuration options are passed to the plugin when started: Argument name These configuration options contain default values determined by the rstudio-launcher binary, and include configuration options set in the /etc/rstudio/nf config file. Each plugin is passed a set of configuration values as arguments to the plugin when it is started.