Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update scheduler architecture documentation #2387

Merged
merged 15 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions docs/source/developer_documentation/mula.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ rankers.

### Stack, packages and libraries

| Name | Version | Description |
|----------------|----------|----------------------------------------------------|
| Python | ^3.8 | |
| FastAPI | ^0.93.0 | Used for api server |
| SQLAlchemy | ^1.4.48 | |
| Name | Version | Description |
| ---------- | -------- | ------------------- |
| Python | ^3.8 | |
| FastAPI | ^0.109.0 | Used for api server |
| SQLAlchemy | ^2.0.23 | |
| pydantic | ^2.5.2 | |

### External services

The scheduler interfaces with the following services:

| Service | Usage |
|-------------|--------------------------------------------------------------------------|
| [Octopoes] | Retrieving random OOI's of organizations |
| [Katalogus] | Used for referencing available plugins and organizations |
| [Bytes] | Retrieve last run boefje for organization and OOI |
| [Boefjes] | Sending boefje, and normalizer tasks to Celery |
| [RabbitMQ] | Used for retrieving scan profile changes, and created raw data in bytes |
| Service | Usage |
| ----------- | ----------------------------------------------------------------------- |
| [Octopoes] | Retrieving random OOI's of organizations |
| [Katalogus] | Used for referencing available plugins and organizations |
| [Bytes] | Retrieve last run boefje for organization and OOI |
| [RabbitMQ] | Used for retrieving scan profile changes, and created raw data in bytes |

### Project structure

Expand All @@ -54,9 +54,9 @@ $ tree -L 3 --dirsfirst
│   ├── models/ # internal model definitions
│   ├── queues/ # priority queue
│   ├── rankers/ # priority/score calculations
│   ├── repositories/ # data abstraction layer
│   ├── storage/ # data abstraction layer
│   ├── schedulers/ # schedulers
│   ├── server/ # scheduler rest api interface
│   ├── server/ # http rest api server
│   ├── utils/ # common utility functions
│   ├── __init__.py
│   ├── __main__.py
Expand All @@ -65,8 +65,11 @@ $ tree -L 3 --dirsfirst
└─── tests/
   ├── factories/
   ├── integration/
   ├── mocks/
   ├── scripts/
   ├── simulation/
   ├── unit/
   ├── utils/
   └── __init__.py
```

Expand Down
Loading
Loading