DiamondLightSource / DiamondLightSource/blueapi
Use cases for BlueAPI Deployment PVC
- Dominant language
- Python
- Stars
- 13
- Forks
- 13
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 25
Description
As a support engineer wanting to manage my deployments I would like to do the following (in order of importance):
* Roll back to a known "good" PVC
* Have BlueAPI make a new PVC pulling a clean `main` (or a release tag) of my repos, the current PVC should be kept around
* Remotely see if my current PVC has uncommited changes
* Read the code in an old PVC without changing live
* Delete an old PVC
* See when a PVC was made/last used/last edited
* Delete based on some criteria e.g. all that haven't been used for X time
## Acceptance Criteria
- All the above are documented on how to do them
- If they are hard or require more than 2 or 3 steps there are issues to make them easier
Contributor guide
Research direction
Start by locating the existing BlueAPI deployment and PVC documentation, then check each listed workflow: rollback, creation, change detection, read-only access, deletion, and usage metadata. Document how to perform every workflow, and create follow-up issues for any that take more than two or three steps.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, infrastructure
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100