distillery v2.0.0-rc.1 Mix.Releases.Runtime.Control

This module defines the tooling for interacting with nodes, as well as other utiltiy functions of use.

Link to this section Summary

Functions

Describes the current release

Executes an expression or a file locally (i.e. not on the running node)

Installs a release, unpacking if necessary

Main entry point for this script

Pings a peer node

This function executes before any commands are dispatched

Prints information about a remote node

Reboots a peer node (this is a hard restart, emulator is restarted)

Applies any pending configuration changes in config files to a peer node

Restarts a peer node (this is a soft restart, emulator is left up)

Executes an expression or a file on a remote node

Stops a peer node

Unpacks a release in preparation for it to be loaded

Link to this section Functions

Link to this function describe(argv, opts)

Describes the current release

Link to this function eval(arg1, arg2)

Executes an expression or a file locally (i.e. not on the running node)

Link to this function install(argv, map)

Installs a release, unpacking if necessary

Main entry point for this script.

Handles parsing and validating arguments, then dispatching the selected command

Link to this function parse_args(argv)
Link to this function ping(args, map)

Pings a peer node.

Link to this function pre_dispatch(cmd, argv, opts)

This function executes before any commands are dispatched

Link to this function processes_info(argv, opts)

Prints information about a remote node.

Link to this function reboot(args, map)

Reboots a peer node (this is a hard restart, emulator is restarted)

Link to this function reload_config(argv, opts)

Applies any pending configuration changes in config files to a peer node.

Link to this function restart(args, map)

Restarts a peer node (this is a soft restart, emulator is left up)

Link to this function rpc(argv, opts)

Executes an expression or a file on a remote node.

Link to this function stop(args, map)

Stops a peer node

Link to this function unpack(argv, map)

Unpacks a release in preparation for it to be loaded