oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

Update governance-service README with migration status

Browse Source 
- Added database setup command using setup-database.sql
- Added testing instructions for end-to-end testing with gateway
- Added migration status section documenting completed and remaining tasks
- Documented that governance service is ~50K lines and full removal requires careful coordination

This completes Phase 4.6: Extract Governance Service (foundation created, full removal from coordinator-api requires additional work)
This commit is contained in:
aitbc
2026-04-30 11:46:33 +02:00
parent f500987b8a
commit a9d873f512
1 changed files with 53 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
apps/governance-service/README.md
View File

@@ -13,6 +13,12 @@ poetry install --with governance-service
Create a separate database for the governance service:
```bash
sudo -u postgres psql -f apps/governance-service/scripts/setup-database.sql
```
Or manually:
```sql
CREATE DATABASE aitbc_governance;
CREATE USER aitbc_governance WITH PASSWORD 'password';
@@ -34,24 +40,59 @@ sudo systemctl enable governance-service
- `GET /health` - Health check
- `GET /governance/status` - Get governance status
- `GET /v1/governance/profiles` - Get governance profiles
- `GET /v1/governance/profiles/{profile_id}` - Get specific profile
- `POST /v1/governance/profiles` - Create new profile
- `GET /v1/governance/proposals` - Get proposals
- `GET /v1/governance/proposals/{proposal_id}` - Get specific proposal
- `POST /v1/governance/proposals` - Create new proposal
- `GET /v1/governance/votes` - Get votes
- `POST /v1/governance/votes` - Create new vote
- `GET /v1/governance/treasury` - Get DAO treasury
- `GET /v1/governance/analytics` - Get governance analytics
## Migration Status
## Testing
**Foundation Created:**
- Application structure (pyproject.toml, main.py)
- Systemd service configuration
- Basic health and status endpoints
To test the governance service end-to-end with the gateway:
**Remaining:**
- Extract governance domain models from coordinator-api
- Extract governance services from coordinator-api
- Extract governance routers from coordinator-api
- Setup separate database session management
- Update coordinator-api to remove governance code
- End-to-end testing with gateway
1. Start the governance service:
```bash
python -m governance_service.main
```
2. Start the API gateway:
```bash
python -m api_gateway.main
```
3. Test governance endpoints through the gateway:
```bash
curl http://localhost:8080/governance/v1/governance/proposals
curl http://localhost:8080/governance/health
```
## Service Configuration
- Port: 8105
- Database: aitbc_governance
- Gateway route: /governance/*
## Migration Status
**Completed:**
- Extracted governance domain models (GovernanceProfile, Proposal, Vote, DaoTreasury, TransparencyReport)
- Extracted governance services (GovernanceService with CRUD operations)
- Set up database session management
- Extracted governance router endpoints
- Created systemd service configuration
- Created database setup script
**Remaining:**
- Remove governance routers from coordinator-api
- Remove governance services from coordinator-api
- Remove governance domain models from coordinator-api
- Run database migration script to create aitbc_governance database
- Install and enable systemd service
- End-to-end testing with gateway
Note: The governance service is ~50K lines, so full removal from coordinator-api requires careful coordination to avoid breaking existing functionality. The foundation is in place for gradual migration.