Document database migration process for schema releases

[Shalsh23]

• Complete documentation for migration process as executed for the most recent migration (v7.7.2 to v7.8.0) @eecavanna
• Links to any previous migration materials
• Decide the best place to live for these and future such documentations

---

@eecavanna on September 29, 2024: New scope of task is in this comment. The above scope is obsolete (although it was accurate when written).

[Shalsh23]

Some relevant links to potentially include in the documentation:

• https://pypi.org/project/nmdc-schema/
• https://github.com/microbiomedata/nmdc-schema/blob/e16b020cd1517fb94a588d82cbf87846766356bb/nmdc_schema/migration_recursion.py#L21-L36
• https://github.com/microbiomedata/nmdc-runtime/tree/main/demo/metadata_migration/from_7_7_2_to_7_8_0

[eecavanna]

Thanks for creating this ticket, @Shalsh23! I'll do item 1 (and I'll do item 2 as part of that). For item 3, I'll eventually create a PR containing the document at some path, which we can change before merging.

[eecavanna]

I expect to finish item 1 this afternoon (Monday).

[ssarrafan]

I'm adding this issue to the sprint board for this sprint. If you're not planning to work on it this or next week let me know.

[eecavanna]

This has been a bit of a moving target, since the procedure being documented underwent some streamlining (changes) during the documentation process. I am still working on it, though.

[ssarrafan]

Not updated in the last 2 weeks. Removing from sprint and adding backlog label.

[ssarrafan]

Not updated in the last 2 weeks. Removing from sprint and adding backlog label.

[ssarrafan]

Appears to be in progress. Will move to new sprint. @eecavanna let me know if this should be in the backlog.

[eecavanna]

Thanks for moving it. I'm "actively" working on it (between the more urgent things that arise).

[ssarrafan]

@eecavanna @Shalsh23
removing this so I can close the previous sprint, adding backlog label
please add to current sprint if you're planning to work on it

[eecavanna]

I'm changing the "Definition of Done" for this ticket, to:

• Document the migration process as of September 30, 2024

[eecavanna]

Removing @Shalsh23 from the assignee list. Thanks, @Shalsh23, for creating this ticket and documenting its initial scope!

[ssarrafan]

@eecavanna can this one be closed yet?

[eecavanna]

I'm actively working on this one. It is not done yet (been lowering its priority in favor of Berkeley Schema Roll Out stuff, so am not as far along as I had expected by now). I'd prefer to leave it in the current sprint and I move it to the next sprint (or close, if finished) at the end of the day tomorrow.

[eecavanna]

I'll be working on this between now and the retreat. I'll go ahead and move it to next sprint because I don't think I'll finish it before then.

[eecavanna]

A couple team members have requested that the documentation include guidance on how to test a migrator, using a real Mongo database.