Loading
ci: add dynamic db entity relationship diagram generation
What does this MR do?
The registry db is constantly evolving and as such it is sometimes difficult to remember the relationships between all the existing registry db entities (i.e tables, indexes, keys etc).
This MR adds a ci pipeline job to dynamically keep and display in a doc a .png visual of the most updated entity relationships introduced to the registry schema on the default branch (i.e. master) :
The generated ERD from the most recent pipeline on this branch:

- The ERD
.pngis automatically generated and displayed in the docs (at !1381 (diffs)) on merge to themasterbranch - The ERD
.pngfile can also be manually generated on nonmasterbranch by manually running the job (if needed) - The generated ERD ignores partitions, given as the amount of the partitions on the registry db makes the graph un-readable
Author checklist
- Feature flags
- Added feature flag:
- This feature does not require a feature flag
- I added unit tests or they are not required
- I added documentation (or it's not required)
- I followed code review guidelines
- I followed Go Style guidelines
- For database changes including schema migrations:
- Manually run up and down migrations in a postgres.ai production database clone and post a screenshot of the result here.
- If adding new queries, extract a query plan from postgres.ai and post the link here. If changing existing queries, also extract a query plan for the current version for comparison.
- Do not include code that depends on the schema migrations in the same commit. Split the MR into two or more.
- Ensured this change is safe to deploy to individual stages in the same environment (
cny->prod). State-related changes can be troublesome due to having parts of the fleet processing (possibly related) requests in different ways.
Reviewer checklist
- Ensure the commit and MR tittle are still accurate.
- If the change contains a breaking change, apply the breaking change label.
- If the change is considered high risk, apply the label high-risk-change
- Identify if the change can be rolled back safely. (note: all other reasons for not being able to rollback will be sufficiently captured by major version changes).
If the MR introduces database schema migrations:
- Ensure the commit and MR tittle start with
fix:,feat:, orperf:so that the change appears on the Changelog
If the changes cannot be rolled back follow these steps:
- If not, apply the label cannot-rollback.
- Add a section to the MR description that includes the following details:
- The reasoning behind why a release containing the presented MR can not be rolled back (e.g. schema migrations or changes to the FS structure)
- Detailed steps to revert/disable a feature introduced by the same change where a migration cannot be rolled back. (note: ideally MRs containing schema migrations should not contain feature changes.)
- Ensure this MR does not add code that depends on these changes that cannot be rolled back.
Edited by Hayley Swimelar