Documentation

The type for command-line options to hyperionMain. Here a is the type for program-specific options. In practice we want a to be an instance of Show

Main command-line option parser for hyperionMain. Returns a Parser that supports commands "worker" and "master", and uses workerOpts or the supplied parser, respectively, to parse the remaining options

Same as hyperionOpts but with added --help option and wrapped into ParserInfo (by adding program description). This now can be used in execParser from Options.Applicative.

hyperionMain produces an IO () action that runs hyperion and can be assigned to main. It performs the following actions

1. If command-line arguments start with command master then

   • Uses the supplied parser to parse the remaining options into type a
   • Uses the supplied function to extract HyperionConfig from a
   • The data in HyperionConfig is then used for all following actions
   • Depending on HyperionConfig, extra actions may be performed, see newClusterEnv.
   • Starts a log in stderr, and then redirects it to a file
   • Starts a hold server from Hyperion.HoldServer
   • Uses setupKeyValTable to setup a Hyperion.Database.KeyValMap in the program database
   • Runs the supplied Cluster () action
   • Cleans up the copy of the executable, if exists (see newClusterEnv).

2. If command-line arguments start with command worker then

   • Extracts Worker from the rest of the command-line args.
   • Logs ServiceId of the worker and the system environment to worker log file.
   • Runs worker (...) :: Process () that connects to the master and waits for a ShutDown message (see worker for details). While waiting, the master can run computations on the node. Low-level functions for this are implemented in Hyperion.Remote, and some higher-level functions in Hyperion.HasWorkers