WALL-E role updates

README.md

@@ -10,12 +10,15 @@ Deployed with Ansible.
 
 If you find new miners or other malicious stuff, please add those signatures to our [`intergalactic-most-wanted-list`](https://github.com/usegalaxy-eu/intergalactic-most-wanted-list).
 
-## Prerequisites
-This role expect several requirements.
-1. [galaxy_jwd.py](https://github.com/usegalaxy-eu/infrastructure-playbook/blob/master/roles/usegalaxy-eu.bashrc/files/galaxy_jwd.py) must exist in the directory of `walle_script_location`
-2. Python 3
-2. the python packages imported in `walle.py` and `galaxy_jwd.py` must be present
-3. Following environment vars must be set:
+## Host machine requirements
+
+1. Python 3 on the host machine
+1. Python dependencies in `walle.py` and `galaxy_jwd.py` must be available (perhaps set `walle_virtualenv` for this)
+    ```
+
+1. Python 3
+1. The python dependencies in `walle.py` and `galaxy_jwd.py` must be available (perhaps in the `walle_virtualenv`)
+1. Following environment vars must be set:
     - `GALAXY_CONFIG_FILE`: Path to the galaxy.yml file
     - `PGDATABASE`: Name of the Galaxy database
     - `PGUSER`: Galaxy database user
@@ -30,11 +33,21 @@ This role expect several requirements.
     - `WALLE_USER_DELETION_SUBJECT`: The message's subject line.
 
 [^1]: You should always run 'dangerous' jobs in embedded Pulsar.
+
 ## Ansible
-For ansible details consult `defaults/main.yml`, it should be pretty much self-explanatory.
+
+1. Your playbook should define the following variables:
+    ```
+    galaxy_config_file: /path/to/galaxy.yml
+    galaxy_log_dir: /path/to/galaxy/log/dir
+    galaxy_pg_db: galaxy
+    galaxy_pg_user: galaxy
+    galaxy_pg_host: my-db-server.usegalaxy.org
+    galaxy_pulsar_app_conf: /path/to/pulsar/app.yml
+1. Consult `defaults/main.yml` for available walle variables
 
 ## Usage
-From the tools help command:
+From the tool's help command:
 ~~~
 usage: WALL·E [-h] [--chunksize CHUNKSIZE] [--min-size MIN_SIZE_MB] [--max-size MAX_SIZE_MB] [--since SINCE] [--tool TOOL] [-v] [-i] [--delete-user MIN_SEVERITY]
 
@@ -86,6 +99,7 @@ optional arguments:
   -h, --help            show this help message and exit
   --chunksize CHUNKSIZE
                         Chunksize in MiB for hashing the files in JWDs, defaults to 100 MiB
+  --kill                Kill malicious jobs with gxadmin.
   --min-size MIN_SIZE_MB
                         Minimum filesize im MB to limit the files to scan. The check will be skipped if value is 0 (default)
   --max-size MAX_SIZE_MB
@@ -96,6 +110,7 @@ optional arguments:
   --tool TOOL           A string to filter tools in the tool_id column of currently running jobs.
                          Use like 'grep' after the gxadmin query queue-details command.
   -v, --verbose         Report details for every match.
+  -d, --debug           Emit additional log messages for debugging Wall-E.
   -i, --interactive     Show table header.
   --delete-user MIN_SEVERITY
                         Delete user when the found malware's severity level is equal or higher than this value.

defaults/main.yml

@@ -10,6 +10,7 @@ walle_python: /usr/bin/python
 walle_database_file: checksums.yml
 walle_log_dir: /var/log/walle
 walle_script_location: /usr/local/bin/walle.py
+#walle_virtualenv: <optional venv for walle to use>
 
 # Script args
 walle_filesize_min: 0
@@ -30,6 +31,13 @@ walle_envs_database:
     value: "{{ galaxy_config_dir }}/galaxy.yml"
   - key: GALAXY_PULSAR_APP_CONF
     value: "{{ galaxy_config_dir }}/pulsar_app.yml"
+  - key: GALAXY_LOG_DIR
+    value: "{{ galaxy_log_dir }}"
+  - key: GXADMIN_PATH
+    value: /usr/local/bin/gxadmin
+
+walle_extra_env_vars: []  # These will be added to the default env vars
+walle_env_vars: "{{ walle_envs_database + walle_extra_env_vars }}"
 
 # delete users when malware was found and malware severity reached walle_delete_threshold
 walle_delete_users: false
@@ -47,6 +55,8 @@ walle_envs_user_deletion:
 # walle_galaxy_url: #galaxy_hostname, no leading slash
 # walle_tool: <string to filter tool ids in database job table>
 walle_verbose: false
+walle_debug: false
+walle_kill: false
 
 # Cron
 walle_cron_day: "*"