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.
    --no-sam        Disables the SAM readiness check.
    --unmerged      Run actions on "/store/unmerged".
    --v1            Connect to Dynamo database directly
    --v1-reporting  Connect to Dynamo database directly for registry only.
    --cnf=FILE      Point to a non-default location of a ``my.cnf`` file.
    --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.

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-invalidate

Usage: consistency-invalidate [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:
    --info        Displays logs down to info level.
    --debug       Displays logs down to debug level.

consistency-invalidate reads from the history database and entered debugged sites into the dynamo server. Site patterns can also be set, if desired.

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.

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.

consistency-dump-tree

Usage: consistency-dump-tree [options] [NAME]

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.
  --remote        Dump the remote site listing instead of the inventory

  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 database directly
    --test        Run with a test instance of backend module.

Dumps the dynamo_consistency.datatypes.DirectoryInfo tree into <VarDirectory>/cache/<SITE>/<NAME>.pkl. By default, it dumps the tree that would be read from the inventory.

If the [NAME] argument is not given, defaults to inventory.pkl or remote.pkl when using the --remote option.