Executables

The following executables can be used by operators or schedulers to run the consistency check and manage other aspects of the reporting and summary page. They are all installed along with the rest of the modules.

dynamo-consistency

Usage: dynamo-consistency [options]

Options:
  --version       show program's version number and exit
  -h, --help      show this help message and exit
  --config=FILE   Sets the location of the configuration file to read.
  --site=PATTERN  Sets the pattern used to select a site to run on next.

  Logging Options:
    --email       Send an email on uncaught exception.
    --info        Displays logs down to info level.
    --debug       Displays logs down to debug level.

  Behavior Options:
    These options will change the backend loaded and actions taken

    --cms         Run actions specific to CMS collaboration data.
    --unmerged    Run actions on "/store/unmerged".
    --v1          Connect to Dynamo from outside with old Dynamo libraries
    --test        Run with a test instance of backend module.

This program runs the Site Consistency Check for Dyanmo Dynamic Data Management System. See https://ddm-dynamo.readthedocs.io for information about Dynamo and http://dynamo-consistency.readthedocs.io for information about this tool.

set-status

Usage: set-status [options] SITE ACTION

Options:
  --version      show program's version number and exit
  -h, --help     show this help message and exit
  --config=FILE  Sets the location of the configuration file to read.

  Logging Options:
    --info       Displays logs down to info level.
    --debug      Displays logs down to debug level.

  Behavior Options:
    These options will change the backend loaded and actions taken

    --v1         Connect to Dynamo from outside with old Dynamo libraries
    --test       Run with a test instance of backend module.

This script changes the status of a site on the summary webpage. It can be used to unlock from a dead process, disable sites from running, and change whether or not to act on the site.

This script can take a --config <FILE> parameter to point to a configuration file, a la dynamo-consistency.

For the last two arguments, SITE will match the name of the site to change. ACTION can be one of the following

Action	Description
ready	This sets the site status back to idle. This means the site is ready to run. Should be used on a site that’s disabled.
halt	This stops a currently running or locked site. This site is still eligible to run.
disable	Can be applied to a site that is either running or ready. It halts the site and also prevents it from running until set to ready again.
act	Marks a site as one to report results to the registry.
dry	Opposite of act, this action prevents this site from making entries into the registry in future runs.

consistency-web-install

Usage: consistency-web-install [options]

Options:
  --version      show program's version number and exit
  -h, --help     show this help message and exit
  --config=FILE  Sets the location of the configuration file to read.

  Logging Options:
    --info       Displays logs down to info level.
    --debug      Displays logs down to debug level.

  Behavior Options:
    These options will change the backend loaded and actions taken

    --v1         Connect to Dynamo from outside with old Dynamo libraries
    --test       Run with a test instance of backend module.

Installs or updates the webpages for the dynamo-consistency.

dynamo-consistency automatically installs the webpages for you if they don’t exist during its first run. However, it will never update the webpage once it’s there.