Using the Mobile Foundation on IBM Cloud service
This tutorial provides step-by-step instructions to set up a MobileFirst Server instance on IBM Cloud by using the IBM Mobile Foundation on IBM Cloud (Mobile Foundation) service.
Mobile Foundation is a IBM Cloud service that enables quick and easy stand-up of scalable Developer or Production environments of Mobile Foundation v8.0 on Liberty for Java runtime.
The Mobile Foundation service offers the following plan options:
Developer: This plan provisions a MobileFirst Server as a Cloud Foundry app on a Liberty for Java runtime. The plan does not support the use of external databases or define multiple nodes and is restricted to development and testing only. The server instance allows you to register any number of Mobile applications for development and testing. In this plan the Mobile Analytics service is added by default.
Note: the Developer plan does not offer a persistent database, as such be sure to backup your configuration as explained in the Troubleshooting section.
Developer Pro: This plan provisions a MobileFirst Server as a Cloud Foundry app on a Liberty for Java runtime, and allows users to develop and test any number of mobile applications. The plan requires you to have a dashDB OLTP service in place. The dashDB service is created and billed separately. This plan is limited in size and is intended to be used for team-based development and testing activities, not production. Charges depend on the total size of your environment. Optionally, you can add a Mobile Analytics service by clicking the Add Analytics button.
Professional Per Capacity: This plan allows users to build, test and run any number of mobile applications in production, regardless of the number of mobile users or devices. It supports large deployments and High Availability. The plan requires you to have a dashDB OLTP service in place. The dashDB service is created and billed separately. Charges depend on the total size of your environment. Optionally, you can add a Mobile Analytics service by clicking the Add Analytics button.
Professional 1 Application: This plan provisions a MobileFirst Server in a scalable Cloud Foundry app on a Liberty for Java runtime. The plan also requires a dashDB database service, which is created and billed separately. The plan allows users to build and manage a single mobile application. A single mobile application can consist of multiple flavors, such as iOS, Android, Windows, and Mobile Web. Optionally, you can add a Mobile Analytics service by clicking the Add Analytics button.
See the service details for more information about the available plans and their billing.
- Setting up the Mobile Foundation service
- Using the Mobile Foundation service
- Server configuration
- Advanced server configuration
- Adding Analytics support
- Removing Analytics support
- Switching from Analytics deployed with IBM Containers to Analytics service
- Applying MobileFirst Server fixes
- Accessing server logs
- Further reading
Setting up the Mobile Foundation service
To set up the available plans, first follow these steps:
- Go to bluemix.net, login, and click on Catalog.
- Search for Mobile Foundation and click on the resulting tile option.
- Optional. Enter a custom name for the service instance, or use the default provided name.
Select the desired pricing plan, then click Create.
Setting up the developer plan
Creating the Mobile Foundation service creates the MobileFirst Server.
- You can instantly access and work with the MobileFirst Server.
- To access the MobileFirst Server using CLI you will need the credentials, which are available when you click Service credentials available in the left navigation panel of the IBM Cloud console.
Setting up the Developer Pro, Professional Per Capacity and Professional 1 Application plans
These plans require an external dashDB transactional database instance.
Learn more about setting up a dashDB database instance.
If you have an existing dashDB service instance (DashDB Enterprise Transactional 2.8.500 or Enterprise Transactional 12.128.1400), select the Use Existing Service option, and provide your credentials:
1.b. If you do not currently have a dashDB service instance, select the Create New Service option and follow the on-screen instructions:
- Start the MobileFirst Server.
- You can either keep the server configuration at its basic level and click on Start Basic Server, or
- Update the server configuration in the Settings tab, and click on Start advanced server.
During this step a Cloud Foundry app is generated for the Mobile Foundation service, and the MobileFirst Foundation environment is being initialized. This step can take between 5 to 10 minutes.
With the instance ready, you can now use the service.
Using the Mobile Foundation service
With the MobileFirst Server now running, you are presented with the following Dashboard:
Click on Add Analytics to add Mobile Analytics support to your server instance. Learn more in the Adding Analytics support section.
Click on Launch Console to open the MobileFirst Operations Console. The default user name is “admin” and the password can be revealed by clicking on the “eye” icon.
The basic server instance consists of:
- A single node (server size: “small”)
- 1GB memory
- 2GB storage capacity
Advanced server configuration
Through the Settings tab, you can further customize the server instance with
- Varying node, memory, and storage combinations
- MobileFirst Operations Console admin password
- LTPA keys
- JNDI configuration
- User registry
- Mobile Analytics configuration
- DashDB Enterprise Transactional 2.8.500 or Enterprise Transactional 12.128.1400 database selection (available in the Professional 1 Application plan)
Adding Mobile Analytics support
You can add Mobile Analytics support to your Mobile Foundation service instance by clicking on Add Analytics from the service’s Dashboard page. This action provisions a Mobile Analytics service instance.
When you create or recreate the Developer plan instance of Mobile Foundation service, the Mobile Analytics service instance is added by default.
Once the operation finishes, reload the MobileFirst Operations Console page in your browser to access the Mobile Analytics Console.
Learn more about Mobile Analytics in the Mobile Analytics category.
Removing Mobile Analytics support
You can remove the Mobile Analytics support for your Mobile Foundation service instance by clicking on Delete Analytics from the service’s Dashboard page. This action deletes the Mobile Analytics service instance.
Once the operation finishes, reload the MobileFirst Operations Console page in your browser.
Switching from Analytics deployed with IBM Containers to Analytics service
Note: Deleting Mobile Analytics will remove all available analytics data. This data will not be available in the new Mobile Analytics instance.
User can delete current container by clicking on Delete Analytics button from service dashboard. This will remove the analytics instance and enable the Add Analytics button, which the user can click to add a new Mobile Analytics service instance.
Applying MobileFirst Server fixes
Updates to the Mobile Foundation on IBM Cloud services are applied automatically without a need for human intervention, other than agreeing to perform the update. When an update is available, a banner is displayed in the service’s Dashboard page with instructions and action buttons.
Accessing server logs
To access server logs, follow the steps described below.
- Set up your host machine.
To manage the IBM Cloud Cloud Foundry app, you need to install the Cloud Foundry CLI.
Install the Cloud Foundry CLI.
- Open the terminal and log in to your Organization and Space using
- Execute the following command in the CLI:
cf ssh <mfp_Appname> -c "/bin/cat logs/messages.log" > messages.log
- Only if trace is enabled, execute the following command:
cf ssh <mfp_Appname> -c "/bin/cat logs/trace.log" > trace.log
- To access server logs, open the sidebar navigation and click on Apps → Dashboard → Cloud Foundry Apps.
- Select your App and click on Logs → View in Kibana.
- Select and copy the logs messages.
To enable tracing, in order to view DEBUG-level messages in the trace.log file:
- In Runtime → Memory and Instances, select your service instance (instance IDs start with 0).
- Click the Trace action option.
- Input the following trace statement:
com.ibm.mfp.*=alland click Submit trace.
The trace.log file is now available in the above specified location.
The Developer plan does not offer a persistent database, which could cause at times loss of data. To quickly onboard in such cases, be sure to follow these best practices:
- Every time you make any of the following server-side actions:
- Deploy an adapter or update any adapter configuration or property value
- Perform any security configuration such scope-mapping and alike
Run the following from the command-line to download your configuration to a .zip file:
$curl -X GET -u admin:admin -o export.zip http://<App Name>.mybluemix.net/mfpadmin/management-apis/2.0/runtimes/mfp/export/all
In case you recreate your server or lose your configuration, run the following from the command-line to import the configuration to the server:
$curl -X POST -u admin:admin -F file=@./export.zip http://<App Name>.mybluemix.net/mfpadmin/management-apis/2.0/runtimes/mfp/deploy/multi
Now that the MobileFirst Server instance is up and running,
- Familiarize yourself with the MobileFirst Operations Console.
- Experience MobileFirst Foundation with these Quick Start tutorials.
- Read through all available tutorials.