Comment 11 for bug 1431045

Revision history for this message
Antonio Rosales (arosales) wrote : Re: New charm: gpfs

@ Michael,

Thanks for the continued work on this charm. I have the below suggestions. The mostly pertain to how we can handle the binaries not being included in the charm. The suggestions are made from trying to keep the user experience as smooth as possible.

--- Overview --
Suggest to add what the charm does, and a link to general information about the GPFS software. For example:
http://www-01.ibm.com/support/knowledgecenter/SSFKCN/gpfs_welcome.html?lang=en
http://www-03.ibm.com/software/products/en/software
http://www-03.ibm.com/systems/storage/spectrum/scale/

Or add this information to a section named "## IBM MQ Project Information"

--- Usage ---
Please detail instructions on what a user needs to specifically do to obtain GPFS software. README currently reads:

>To install GPFS, you need to download the packages for Ubuntu and create a apt repository. To acquire and download GPFS, follow >instructions: [add link].

Suggest to detail how the users gets the GPFS binary (what URL to visit, what web workflow to follow, what points to take note of during the web workflow), and then once the user downloads the binary detail how the user places the binary into the charm so it can be deployed locally. Also note in the caveats that the charm must be deployed locally if we can not ship the binaries in the charm and license set. Are there any trail options?

---- Creating the repositories ----
In creating the repo section if you would like the commands to read as "code" you'll need to indent 4 spaces and have a new-line before and after:
  https://guides.github.com/features/mastering-markdown/

--- Configuration ---
Ensure instructions and examples to use all config options are listed as this is the only mechanism users can follow to use the config options.

For the next iterations of your charm to make the off-line process more stream lined you may also want to consider charm resources:
  http://jujuresources.readthedocs.org/en/latest/
This is currently being used in the Apache Hadoop Charms:
  http://bazaar.launchpad.net/~bigdata-dev/charms/trusty/apache-hadoop-client/trunk/view/head:/hooks/common.py

We'll coordinate with you on how we can obtain binaries for the review and charm CI going forward. I'll move the status of this bug to "Incomplete" while you address the above. Please update the status to "Fix Committed" when you are ready for another review.

-thanks,
Antonio