first commit
This commit is contained in:
36
README.md
Normal file
36
README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# RoleForge Backend
|
||||
|
||||
Backend for an Ansible orchestration platform.
|
||||
|
||||
The project is designed to run fully in Docker, without installing Python dependencies on the host.
|
||||
|
||||
Includes:
|
||||
- Playbook execution
|
||||
- Molecule-based role/playbook test runs with dynamic container inventory
|
||||
- Realtime logs over WebSocket
|
||||
|
||||
## Structure
|
||||
|
||||
- `app/` - all application source code, templates, and SQL bootstrap
|
||||
- `docs/` - project documentation
|
||||
- `k8s/` - Kubernetes manifests
|
||||
|
||||
## Quick start
|
||||
|
||||
1. Create local env file:
|
||||
- `cp .env.example .env`
|
||||
2. Start project:
|
||||
- `make up`
|
||||
3. Open:
|
||||
- `http://localhost:8000/docs`
|
||||
|
||||
## Main commands
|
||||
|
||||
- `make up` - start services (`api`, `postgres`, `redis`)
|
||||
- `make down` - stop services
|
||||
- `make logs` - view logs
|
||||
- `make ps` - service status
|
||||
- `make db-shell` - open PostgreSQL shell
|
||||
- `make api-shell` - shell in API container
|
||||
|
||||
Detailed usage is in `docs/runbook.md`.
|
||||
Reference in New Issue
Block a user