Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<Describe which user roles are related to the problem AND the solution, e.g. admin, deployer, node owner, etc. If you need to define a new role in your design, make that very clear. Remember this is about what a user is thinking when interacting with the system before and after this design change. This section is not about a UI, it's more abstract than that. This section should explain all the aspects of the proposed feature that will surface to users.>


  • Needs to be a drop-in replacement for Vault initially.
  • Need to establish a long term onboard for Vault users looking to switch as projects naturally diverge.


Command Line Interface

<Describe any changes to the hzn CLI, including before and after command examples for clarity. Include which users will use the changed CLI. This section should flow very naturally from the User Experience section.>

...

<List all of the internal components (agent, MMS, Exchange, etc) which need to be updated to support the proposed feature. Include a link to the github epic for this feature (and the epic should contain the github issues for each component).>


None, should be a drop-in replacement.


Security

<Describe any related security aspects of the solution. Think about security of components interacting with each other, users interacting with the system, components interacting with external systems, permissions of users or components>


  • Will need a dedicated method for handling CVE reporting and resolution. This may need to be separate from other Open Horizon components.


APIs

<Describe and new/changed/deprecated APIs, including before and after snippets for clarity. Include which components or users will use the APIs.>


  • None


Build, Install, Packaging

<Describe any changes to the way any component of the system is built (e.g. agent packages, containers, etc), installed (operators, manual install, batch install, SDO), configured, and deployed (consider the hub and edge nodes).>


  • New docker images will need to be produced under Open Horizon's DockerHub repository.
  • Priority will be given to core Vault services over UI, plugins, SDKs, etc.
  • Do we have requirements for multiple patch releases?
  • Do we have requirements for multiple minor version streams?


Documentation Notes

<Describe the aspects of documentation that will be new/changed/updated. Be sure to indicate if this is new or changed doc, the impacted artifacts (e.g. technical doc, website, etc) and links to the related doc issue(s) in github.>


  • Removal of Hashicorp references, including enterprise offerings.
  • Changes to responsible parties in charge of each component of the repo.
  • May need a placeholder name change such as Terraform to OpenTF.


Test

<Summarize new automated tests that need to be added in support of this feature, and describe any special test requirements that you can foresee.>