A Grafana dashboard implementation offering unified observability over a suite of patch management tools.
Tenable API keys (an access key and a secret key) are required to properly execute this program. It is recommended that you set environment variables to keep the credentials on your system. A guide on how to do this can be found here - this guidance follows recommendations from OpenAI on the best practices for API Key Safety, available here.
Set up the virtual environment and dependencies by typing the following commands:
python3.12 -m pip install virtualenv
python3.12 -m virtualenv .venv
source .\.venv\Scripts\activate
pip install -r requirements.txt
Linux users can set up the virtual environment and dependencies by navigating to the project directory and executing the install.sh shell script with the following command:
./install.sh
Activate the virtual environment with the following command:
source .venv/bin/activate
Execute the program with the following command:
python3.12 __main__.py
To deactivate the virtual environment after program execution is complete, use the following command:
deactivate
Before the first run, the database must first be migrated. golang-migrate is used to handle database migration. To run all the migrations for each database, make sure the golang-migrate binary is downloaded first by running install.sh. Then, run:
./golang-migrate/migrate -path ./src/<insert pmt name>/migrations -database "mysql://user:pass@tcp(domain:port)/<db-name>" upwhere:
<insert pmt name>is the name of the patch management tool for which this migration is run, e.g. tenableuseris the username of the databasepassis the password used to identify the userdomainis the domain at which the MySQL/MariaDB instance is runningportis the port on which the DB is listening<db-name>is the name of the database that holds data for a specific patch management tool, e.g. tenable
Go to docs/database.md for further documentation on database.