View Source FLAME.Parent (flame v0.5.2)
Conveniences for looking up FLAME parent information.
Parent Information
When a FLAME child is started, it contains the FLAME_PARENT
environment
variable that holds the parent node's information base 64 encoded into a
map, with the following keys:
:ref
- The parent node's reference.:pid
- The parent node's Pid.:backend
- The FLAME backend in use.:flame_vsn
- The FLAME version running on the parent.:backend_app
- The FLAME backend application running on the parent.:backend_vsn
- The FLAME backend version running on the parent.:node_base
- The node basename the parent generated for the runner.:host_env
- The environment variable name on the runner to use to lookup the runner's hostname for the runner's longname.
Summary
Functions
Encodes a %FLAME.Parent{}
struct into string.
Gets the %FLAME.Parent{}
struct from the system environment.
Returns a new %FLAME.Parent{}
struct.
Functions
Encodes a %FLAME.Parent{}
struct into string.
Gets the %FLAME.Parent{}
struct from the system environment.
Returns nil
if no parent is set.
When booting a FLAME node, the FLAME.Backend
is required to
export the FLAME_PARENT
environment variable for the provisioned
instance. This value holds required information about the parent node
and can be set using the encode/1
function.
Returns a new %FLAME.Parent{}
struct.
The pid
is the parent node's FLAME.Runner
process started by
the FLAME.Pool
.