Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve v5 to v6 migration documentation #3516

Open
stevenvegt opened this issue Oct 24, 2024 · 4 comments
Open

Improve v5 to v6 migration documentation #3516

stevenvegt opened this issue Oct 24, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@stevenvegt
Copy link
Member

stevenvegt commented Oct 24, 2024

There are some questions about the differences between nuts-nove v5 and v6. We need to improve the information so users can make better informed decisions.

We can use this page: https://nuts-node.readthedocs.io/en/latest/pages/deployment/migration.html

Questions we need to answer:

  • What is the concept of a subject? (For a vendor, this will probably always be your customer)
  • What is did:web and why do we now have 2 did methods?
  • I use the did:nuts now as an identifier in my CRM, will this still work with the nuts v6 node after the migration and introduction of the did:web method?
  • Can I use v5 use-cases with a v6 node?
  • Can my v6 node communicate with a v5 node?
  • If I want to use a v6 use-case on a v6 node, do I need to rewrite my v5 use-cases to v6 use-cases?
  • What are my options for a SQL backend?
  • How do I choose a DB backend? How much data will there be stored, hoe much read and wrote operations?
  • What access-rights does the Nuts node need on the SQL server?
  • How can I migrate the data from v5 to a SQL backend?
  • What if the DB migration fails during startup?
  • Can I stop using v5 data stores like Redis after updating to v6?
  • Since all data is now stored in a DB, can I stop backing up the files in the data directory after updating to v6?
  • What about this controller thing in the DID documents, how will this effect my current integration?
  • Do I still need a vendor-did in my config file?
  • If I don't upgrade to v6, how long will v5 be supported?
  • If I use deprecated features in v6, when can I expect a v7 and how much time do I have to migrate?
@stevenvegt stevenvegt added the documentation Improvements or additions to documentation label Oct 24, 2024
@jorritspee
Copy link

In v5, data could be localized by a data user by querying and inspecting NutsAuthorizationCredentials. What is the preferred way to localize data (i.e. find the did's of data holders) in v6, FHIR CareTeam?

@HansSDBGroep
Copy link

What is the impact of eOverdracht and ANW when updating the nuts node to v6? Do you need to change the functionality to work with v6? Or is only change necessary to work with the new v6 way of use cases?
Is there documentation how eOverdracht and ANW should be implemented in the new v6 way?
Is it possible to migrate external keystore to the built in keystore?
Is all data migrated to the database or is still data stored in files?

@woutslakhorst
Copy link
Member

Can the initial list be filtered with the current documentation and release notes. Questions like What are my options for a SQL backend? are clearly documented.

The read the docs only contain information about the usage of the software. Any functional usage (use cases) should be documented on the wiki. This includes localisation questions and eOverdracht/ANW questions.

@SimonVeldhuijzen
Copy link

The version incompatibilities page states: Do not use the VDR V1 and VDR V2 API at the same time. This will lead to unexpected behavior.

Does this only apply to creating DID documents? Can we still resolve a did through the VDR V1 API when it was created through the VDR V2 API? And if not, is the schema and data returned in /internal/vdr/v1/did/{did} the same as in /internal/vdr/v2/did/{did}?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants