Skip to main content

Argus

Project description

Argus

Description

Argus is a test tracking system intended to provide observability into automated test pipelines which use long-running resources. It allows observation of a test status, its events and its allocated resources. It also allows easy comparison between particular runs of a specific test.

Installation notes

Development

For development setup instructions, see dev-setup.md.

Prerequisites

  • Python >=3.10.0 (system-wide or pyenv)

  • NodeJS >=16 (with npm)

  • Yarn (can be installed globally with npm -g install yarn)

  • nginx

  • poetry >=1.2.0b1

From source

Production

Perform the following steps:

Create a user that will be used by uwsgi:

useradd -m -s /bin/bash argus
sudo -iu argus

(Optional) Install pyenv and create a virtualenv for this user:

pyenv install 3.10.0
pyenv virtualenv argus
pyenv activate argus

Clone the project into a directory somewhere where user has full write permissions

git clone https://github.com/scylladb/argus ~/app
cd ~/app

Install project dependencies:

poetry install --with default,dev,web-backend,docker-image
yarn install

Compile frontend files from /frontend into /public/dist

yarn webpack

Create a argus.local.yaml configuration file (used to configure database connection) and a argus_web.yaml (used for webapp secrets) in your application install directory.

cp argus_web.example.yaml argus_web.yaml
cp argus.yaml argus.local.yaml

Open argus.local.yaml and add the database connection information (contact_points, user, password and keyspace name).

Open argus_web.yaml and change the SECRET_KEY value to something secure, like a sha512 digest of random bytes. Fill out GITHUB_* variables with their respective values.

Copy nginx configuration file from docs/configs/argus.nginx.conf to nginx virtual hosts directory:

Ubuntu:

sudo cp docs/configs/argus.nginx.conf /etc/nginx/sites-available/argus
sudo ln -s /etc/nginx/sites-enabled/argus /etc/nginx/sites-available/argus

RHEL/Centos/Alma/Fedora:

sudo cp docs/configs/argus.nginx.conf /etc/nginx/conf.d/argus.conf

Adjust the webhost settings in that file as necessary, particularly listen and server_name directives.

Copy systemd service file from docs/config/argus.service to /etc/systemd/system directory:

sudo cp docs/config/argus.service /etc/systemd/system

Open it and adjust the path to the start_argus.sh script in the ExecStart= directive and the user/group, then reload systemd daemon configuration and enable (and optionally start) the service.

WARNING: start_argus.sh assumes pyenv is installed into ~/.pyenv

sudo systemctl daemon-reload
sudo systemctl enable --now argus.service

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

argus_alm-0.12.7.tar.gz (94.3 kB view details)

Uploaded Source

Built Distribution

argus_alm-0.12.7-py3-none-any.whl (125.1 kB view details)

Uploaded Python 3

File details

Details for the file argus_alm-0.12.7.tar.gz.

File metadata

  • Download URL: argus_alm-0.12.7.tar.gz
  • Upload date:
  • Size: 94.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Linux/6.10.6-200.fc40.x86_64

File hashes

Hashes for argus_alm-0.12.7.tar.gz
Algorithm Hash digest
SHA256 8580e59e0ce462401c7a6a1dd089a25b5350fb73c8d8930395d375531dccdb03
MD5 b0cb199d9ad250976f8f26b6aac5968f
BLAKE2b-256 0557498060428719a44b3792d09e9a9893c54e4017f77bd326088d066537dd90

See more details on using hashes here.

File details

Details for the file argus_alm-0.12.7-py3-none-any.whl.

File metadata

  • Download URL: argus_alm-0.12.7-py3-none-any.whl
  • Upload date:
  • Size: 125.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Linux/6.10.6-200.fc40.x86_64

File hashes

Hashes for argus_alm-0.12.7-py3-none-any.whl
Algorithm Hash digest
SHA256 61c58cb99f187e686209eacf132c4aa23ca31d8582454e8dc59156622e2d7aa5
MD5 1e78e58f9835b2c45099e8c486bd8cd2
BLAKE2b-256 45d0a00c451d339908bf44b41390953450eae922dbd3cf9bbc8c5708a74eb944

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page