Add an admin api
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
As a hub operator, it would be useful to be able to:
- change values of hub component settings without restarting the components
- check the status of hub components
- run diagnostics and maintenance on the database (scan for integrity errors, repair damaged dbs, rebuild indexes, drop optional indexes, etc)
- request usage statistics
- request hub component resource usage information
- request mempool / other information from either lbcd or lbrycrd directly
- call `generate` on lbcd/lbrycrd on regtest so that the docker stack can be used for integration tests
A new `HubAdminService` can be added that can expose a single admin api to do these things across the other running and configured hub services.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed HubAdminService and the configured hub services it would coordinate, including lbcd, lbrycrd, and the database. Break the requested operations into defined API responsibilities, then verify that the design covers component settings, status, diagnostics, usage data, resource information, direct daemon information, and regtest generation for the docker stack.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- api, backend, blockchain, database, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100