search

IBM-Blockchain-Archive / cp-web

A demonstration of a commercial paper trading application on IBM Blockchain.
Apache License 2.0
94 stars 232 forks source link

Improve Documentation to Indicate that Commercial Paper Cannot be Redeployed #68

Open altharp opened 7 years ago

altharp commented 7 years ago

Users that are new to using the IBM Blockchain service made changes to the Commercial Paper demonstration and then attempted to deploy it on the same blockchain network that was initially used to deploy the demonstration. Refer to feedback in the February 13 comment at https://github.com/IBM-Blockchain/cp-web/issues/67.

This scenario will not work with the Commercial Paper demonstration, but the documentation doesn't prominently point this out. The “Notes on the Key Value Store” section near the end of the documentation does explain that the enrollment certificate for the WebAppAdmin user will be downloaded into the Commercial Paper application filesystem on Bluemix. This means that no other applications on the blockchain network will be able to use the WebAppAdmin user (hence the suggestion to use the demonstration on its own blockchain network).

The file system where the enrollment certificate for the WebAppAdmin user is located is in non-persistent storage. If the application is stopped, then the certificate for the WebAppAdmin user is lost. If the certificate is lost, then it cannot be used when the Commercial Paper application is redeployed.

Below are some suggestions for improving the documentation.

  1. Move the “Notes on the Key Value Store” section closer to the top of the documentation so that restrictions related to the WebAppAdmin user and that the Commercial Paper demonstration should be used on a dedicated blockchain network are more prominent.

  2. Also move the “Limitations” section closer to the top of the documentation so that users understand limitations before going through the demonstration.

  3. Clearly state in the list of limitations that the Commercial Paper demonstration cannot be modified and redeployed. This is due to the fact that the enrollment certificate for the WebAppAdmin user is lost and cannot be used on the redeployment attempt.

altharp commented 7 years ago

@marcoess At this point I am not sure if there will be an updated version of the Commercial Paper example. Hyperledger Fabric version 1.0 is currently being developed. All of the examples that were available for Hyperledger Fabric version 0.6 might not necessarily be the same examples that are provided for version 1.0.