Juju Charms Collection

New charm: IBM MobileFirstServer

Bug #1478783 reported by sunitha on 2015-07-28

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	Juju Charms Collection	Triaged	Undecided	Unassigned

Bug Description

Hi,

Here is a new charm for IBM MobileFirst Server for review.

To test this charm we need the principle charm websphere-liberty as ibm-mobilefirst-server is subordinate.

Deployable ibm-mobilefirst-server layer charm can be found in the below repository.
Deployable Charm Repo : https://code.launchpad.net/~ibmcharmers/charms/trusty/ibm-mobilefirst-server/trunk

And, its source code can be found in the below repository.
Source Code Repo : https://code.launchpad.net/~ibmcharmers/charms/trusty/layer-ibm-mobilefirst-server/trunk

Deployable websphere-liberty charm can be found at https://jujucharms.com/websphere-liberty/trusty/3
Deployable ibm-db2 charm can be found at https://jujucharms.com/ibm-db2/trusty

IBM-MobileFirst-Server charm has been pushed into charm store branch : cs:~ibmcharmers/trusty/ibm-mobilefirst-server-19
link: https://jujucharms.com/u/ibmcharmers/ibm-mobilefirst-server/trusty/19

IBM-MobileFirst-Server used db2 interface. Here is the source code link:
https://code.launchpad.net/~ibmcharmers/interface-ibm-db2/trunk

Thanks.

See original description

Related branches

lp:~ibmcharmers/charms/trusty/mobilefirst-server/trunk

lp:~ibmcharmers/charms/trusty/ibm-mobilefirst-server/trunk

Revision history for this message

Matt Bruzek (mbruzek) wrote on 2015-09-04:

Download full text (5.6 KiB)

# IBM MobileFirstServer review

Thank you for the submission of the IBM MobileFirstServer. I am sorry it took so long for someone to look at this charm. As always I am using the Charm Store Policy and Best Practices documents for reference when reviewing charms: https://jujucharms.com/docs/stable/authors-charm-policy https://jujucharms.com/docs/stable/authors-charm-best-practice

Here is my review.

## charm-proof

$ charm proof
I: all charms should provide at least one thing
I: missing recommended hook start

I would have expected this charm to provide something because it is a “server” in the end the deployment succeeded but I was not able to view the web pages, so it is hard for me to tell. Please consider the peer relation, if this software can be set up in a cluster mode.

## README.md
The readme contains many misspelled words and formatting errors that do not convert to HTML correctly. Please refer to the Markdown cheat for formatting tips: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet If you want to see how the HTML looks please view how the readme renders on the personal namespace section of the charm store: https://jujucharms.com/u/ibmcharmers/mobilefirst-server/trusty Once the code is in bzr you can see the new revision in the charm store after a 30 minute update delay. Please note that code blocks must be indented in multiples of 4 for code blocks. In some cases 7 spaces are used, in other cases 2 spaces are used. Alternately you can use three back-ticks for code blocks (``` code here ```). Markdown has special handling for anything between the less than (<) and greater than (>) signs so “juju deploy --to <machine number> db2” converts to the following HTML “juju deploy --to db2” which is an invalid command. Revisit everything with the less than (<) and greater than (>) symbols to ensure they convert to HTML correctly.

The readme needs more specific steps in the setup of the apache2 server, and how to host the file, with examples of paths and file names so the Juju use has a chance to get this correct. As someone reading this charm for the first time I would really want more information about the MobileFirst product, what it does and what I can do with it after deployment.

The deploy instructions are incomplete if I followed those instructions db2 and websphere-liberty would not install because the licenses were not accpted. To install websphere-liberty and db2 users have to accept licenses. The readme doesn't have to cover all the details, but the readme should mention that other steps are needed to deploy the other software and the users should refer to their readme files.

## config.yaml
The configuration file looks good, I would expect to see better descriptions including file name examples in the description. For example if the default for a value is empty string, and the config-changed hook looking for predefined package names, the configuration description should provide those names so the users know what is a valid value.

## install
It looks like you are missing the -y on the first two apt-get install lines. Those could cause a problem in the future if they require other packages t...

# IBM MobileFirstServer review

Thank you for the submission of the IBM MobileFirstServer.  I am sorry it took so long for someone to look at this charm.  As always I am using the Charm Store Policy and Best Practices documents for reference when reviewing charms: https://jujucharms.com/docs/stable/authors-charm-policy  https://jujucharms.com/docs/stable/authors-charm-best-practice

Here is my review.

## charm-proof

$ charm proof
I: all charms should provide at least one thing
I: missing recommended hook start

I would have expected this charm to provide something because it is a “server” in the end the deployment succeeded but I was not able to view the web pages, so it is hard for me to tell.  Please consider the peer relation, if this software can be set up in a cluster mode.

## README.md
The readme contains many misspelled words and formatting errors that do not convert to HTML correctly.  Please refer to the Markdown cheat for formatting tips:  https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet  If you want to see how the HTML looks please view how the readme renders on the personal namespace section of the charm store:  https://jujucharms.com/u/ibmcharmers/mobilefirst-server/trusty  Once the code is in bzr you can see the new revision in the charm store after a 30 minute update delay.  Please note that code blocks must be indented in multiples of 4 for code blocks.  In some cases 7 spaces are used, in other cases 2 spaces are used.  Alternately you can use three back-ticks for code blocks (``` code here ```).  Markdown has special handling for anything between the less than (<) and greater than (>) signs so “juju deploy --to <machine number> db2” converts to the following HTML “juju deploy --to db2” which is an invalid command.  Revisit everything with the less than (<) and greater than (>) symbols to ensure they convert to HTML correctly.

The readme needs more specific steps in the setup of the apache2 server, and how to host the file, with examples of paths and file names so the Juju use has a chance to get this correct.  As someone reading this charm for the first time I would really want more information about the MobileFirst product, what it does and what I can do with it after deployment.

The deploy instructions are incomplete if I followed those instructions db2 and websphere-liberty would not install because the licenses were not accpted.  To install websphere-liberty and db2 users have to accept licenses.  The readme doesn't have to cover all the details, but the readme should mention that other steps are needed to deploy the other software and the users should refer to their readme files.

## config.yaml
The configuration file looks good, I would expect to see better descriptions including file name examples in the description.  For example if the default for a value is empty string, and the config-changed hook looking for predefined package names, the configuration description should provide those names so the users know what is a valid value.

## install 
It looks like you are missing the -y on the first two apt-get install lines.  Those could cause a problem in the future if they require other packages the user will be prompted and that command will not complete without a -y.

## config-changed
There are a mixture of spaces and tabs in the remove_unaccepted_im_software function.

# Performance suggestion
Juju makes it easy for users to request different instance sizes from the cloud providers. The readme should include what kind of constraints work best for this deployment. The default AWS instance has the following constraints root-disk=8192M, and mem=1740M. Since you put all three services on the same instance this deployment used over 10GB of root-disk (according to df -h). That would not deploy on a default instance!  Also with three services running on the same server I suspect that 1.7GB of RAM is not enough.

One would also have to question why the readme co-locates  all three services on the same node (--to <machine number>).  The power of the cloud is that each service can be deployed to a different machine for fault tolerance and no single point of failure.  The cloud makes it easy to deploy as many Vms as are needed.  The charms connect using relations already.  Why do the services have to be on the same server?  I would want to see that these charms work on their own servers smaller servers and they can link up via relations rather than being deployed to one really big server.

# Deployment failure
I deployed the three services and related them without any errors in Juju.  When I tried to connect to https://mobilefirst-server-ip:9443/worklightconsole I was prompted for the username and password.  I guessed admin/admin and that worked.  Two problems with that, the Charm Store Policy does not allow default passwords, and the readme did not contain instructions on how to find the username password information.  I would expect to see the username and password configuration options and if the password is empty generate a random password and store it in a file somewhere a user could find it on the server.  I was not able to connect to http://mobilefirst-server-ip:9081/appcenterconsole with admin/admin and the readme did not tell me how to log in.

Once I got in to the worklightconsole, I saw the following message: “No runtime environment deployed in this server.”  I checked the Juju logs and found no obvious error messages. I will attach the logs to this bug so you can possibly diagnose this problem.

Thanks again for this submission.  I am going to put this charm back into “In Progress” while you work on these issues.  Please feel free to join us in #juju on chat.freenode.net or email juju@lists.ubuntu.com with questions.

Changed in charms:
status:	New → In Progress

Revision history for this message

Matt Bruzek (mbruzek) wrote on 2015-09-04:

The log files from the three units on the server Edit (312.2 KiB, application/x-tar)

Here are the Juju log files from the three units.

Revision history for this message

sunitha (sradhara) wrote on 2015-09-27:

Hi,

Thanks for the review comments. Started working on review comments.

Thanks,
Sunitha.

sunitha (sradhara) on 2015-11-18

description:

updated

sunitha (sradhara) on 2015-11-18

description:

updated

Revision history for this message

sunitha (sradhara) wrote on 2015-11-18:

obileFirst Server can be set up in a cluster mode, but it requires IBM HTTP server.
We have started working on IBM HTTP server charming, once its done I will add cluster code to existing MobileFirst Server charm .

There is a limitation of the MobileFirst Server silent install files. If we install with silent install files, we need to create the databases before we install MobileFirst Server.
Due to this limitation I have created helper charm called "ibm-mfs-helper", which will create a "APPCNTR" and "WRKLHT" databases on db2 conatiner.
ibm-mfs-helper is a service with subordinate as "False" which can be deployed with ibm-mobilefirst-server charm only.

Revision history for this message

sunitha (sradhara) wrote on 2015-11-18:

HI,

MobileFirst Server can be set up in a cluster mode, but it requires IBM HTTP server.
We have started working on IBM HTTP server charming, once its done I will add cluster code to existing MobileFirst Server charm .

Thanks,
Sunitha.

sunitha (sradhara) on 2015-11-19

Changed in charms:
status:	In Progress → Fix Committed

sunitha (sradhara) on 2015-11-26

Changed in charms:
status:	Fix Committed → In Progress

Revision history for this message

Suchitra Venugopal (suchvenu) wrote on 2016-09-06:

Hi,
Here is a new charm for IBM MobileFirst Server for review.

To test this charm we need the principle charm websphere-liberty as ibm-mobilefirst-server is subordinate.

Deployable ibm-mobilefirst-server layer charm can be found in the below repository.
Deployable Charm Repo : https://code.launchpad.net/~ibmcharmers/charms/trusty/ibm-mobilefirst-server/trunk

And, its source code can be found in the below repository.
Source Code Repo : https://code.launchpad.net/~ibmcharmers/charms/trusty/layer-ibm-mobilefirst-server/trunk

Deployable websphere-liberty charm can be found at https://jujucharms.com/websphere-liberty/trusty/3
Deployable ibm-db2 charm can be found at https://jujucharms.com/ibm-db2/trusty

IBM-MobileFirst-Server charm has been pushed into charm store branch : cs:~ibmcharmers/trusty/ibm-mobilefirst-server-19
link: https://jujucharms.com/u/ibmcharmers/ibm-mobilefirst-server/trusty/19

IBM-MobileFirst-Server used db2 interface. Here is the source code link:
https://code.launchpad.net/~ibmcharmers/interface-ibm-db2/trunk

Revision history for this message

Suchitra Venugopal (suchvenu) wrote on 2016-09-06:

There are minor fixes for WLP and DB2 charm required which can be seen in these Merge Proposals. These has to be approved before testing MobileFirst Server charm.

https://code.launchpad.net/~ibmcharmers/charms/trusty/websphere-liberty/trunk/+merge/304442
https://code.launchpad.net/~ibmcharmers/charms/trusty/ibm-db2/trunk/+merge/304972