Covalent Server
Covalent CLI Tool
This Command Line Interface (CLI) tool is used to manage Covalent server.
Covalent
Covalent CLI tool used to manage the servers.
covalent [OPTIONS] COMMAND [ARGS]...
Options
-v, --version
Display version information.
start
Start the Covalent server.
-d, --develop
Start the server in developer mode
-p, --port < port >
Start the server in developer mode
DEFAULT
48008
-m, --mem-per-worker <mem_per_worker>
Memory limit per worker in (GB). Provide strings like 1gb/1GB or 0 for no limits
-n, --workers < workers>
Number of workers to start covalent with.
-t, --threads-per-worker <threads_per_worker>
Number of CPU threads per worker
--ignore-migrations
Start the server without requiring migrations
DEFAULT
False
--no-cluster
Start the server without Dask
DEFAULT
False
--triggers-only
Start only the Triggers server
DEFAULT
False
stop
Stop the Covalent server.
covalent stop [OPTIONS]
restart
Restart the server.
covalent restart [OPTIONS]
Options
-p, --port < port >
Restart Covalent server on a different port.
-d, --develop
Start the server in developer mode
status
Query the status of the Covalent server.
covalent status [OPTIONS]
purge
Purge Covalent from this system. This command is for developers.
covalent purge [OPTIONS]
Options
-H, --hard
Perform a hard purge, deleting the DB as well.
DEFAULT
False
-y, --yes
Approve without showing the warning.
DEFAULT
False
logs
Show Covalent server logs.
covalent logs [OPTIONS]
db
Group of utility commands to manage dispatcher database
covalent db [OPTIONS] COMMAND [ARGS]...
alembic
Expose alembic CLI to be used via covalent CLI
covalent db alembic [OPTIONS] [ALEMBIC_ARGS]...
Arguments
ALEMBIC_ARGS
Optional argument(s)
migrate
Run DB Migrations programatically
covalent db migrate [OPTIONS]
cluster
Inspect and manage the Dask cluster’s configuration.
covalent cluster [OPTIONS]
Options
--status
Show Dask cluster status
--info
Retrieve Dask cluster info
--address
Fetch connection information of the cluster scheduler/workers
--size
Return number of active workers in the cluster
--restart
Restart the cluster
--scale < scale >
Scale cluster by adding/removing workers to match nworkers
DEFAULT
2
--logs
Show Dask cluster logs
Setting Defaults
Default configuration for covalent can be set by defining the environment variable COVALENT_CONFIG_DIR. By default, config files are stored in ~/.config/covalent/covalent.conf.
Example settings in config file
Note
This is a YAML file, so you can use any YAML syntax.
Tip
Each executor comes with its own configuration parameters that is stored in this same config file config file. For example, for SSH plugin, we have the following settings:
[executors.ssh]
username = "user"
hostname = "host.hostname.org"
remote_dir = "/home/user/.cache/covalent"
ssh_key_file = "/home/user/.ssh/id_rsa"
Typical Configuration settings
Generated each time covalent is installed and can be found at ~/.config/covalent/covalent.conf
[sdk]
log_dir = "/Users/he-who-must-not-be-named/.cache/covalent"
log_level = "warning"
enable_logging = "false"
executor_dir = "/Users/voldemort/.config/covalent/executor_plugins"
[dispatcher]
address = "localhost"
port = 48008
cache_dir = "/Users/voldemort/.cache/covalent"
results_dir = "results"
log_dir = "/Users/voldemort/.cache/covalent"
[dask]
cache_dir = "/Users/voldemort/.cache/covalent"
log_dir = "/Users/voldemort/.cache/covalent"
mem_per_worker = "auto"
threads_per_worker = 1
num_workers = 8
scheduler_address = "tcp://127.0.0.1:60690"
dashboard_link = "http://127.0.0.1:8787/status"
process_info = "<DaskCluster name='LocalDaskCluster' parent=80903 started>"
pid = 80924
admin_host = "127.0.0.1"
admin_port = 60682
[workflow_data]
db_path = "/Users/voldemort/.local/share/covalent/workflow_db.sqlite"
storage_type = "local"
base_dir = "/Users/voldemort/.local/share/covalent/workflow_data"
[user_interface]
address = "localhost"
port = 48008
log_dir = "/Users/voldemort/.cache/covalent"
dispatch_db = "/Users/voldemort/.cache/covalent/dispatch_db.sqlite"
[executors.local]
log_stdout = "stdout.log"
log_stderr = "stderr.log"
cache_dir = "/Users/voldemort/.cache/covalent"
[executors.dask]
log_stdout = "stdout.log"
log_stderr = "stderr.log"
cache_dir = "/Users/voldemort/.cache/covalent"