Readme file

        Version last updated: 12/01/2022

        IBM® Mobile Foundation

        ​

        Introduction

        ​
        IBM Mobile Foundation on IBM Cloud is an integrated platform that helps you extend your business to mobile devices. Mobile Foundation includes a comprehensive development environment, mobile-optimized runtime middleware, a private enterprise application store, and an integrated management and analytics console. With Mobile Foundation, developers can efficiently develop, connect, run, and manage rich mobile applications (apps) that accesses the capabilities of target mobile devices. Mobile Foundation helps reduce time-to-market, cost, the complexity of development, and provides a seamless client user experience across touchpoints.
        ​
        Mobile Foundation consists of three major components and each having a set of associated services.
        ​

        • Mobile Foundation Server: mfpserver, mfppush, mfpliveupdate
        • Mobile Foundation Analytics: mfpanalytics_recvr, mfpanalytics
        • Mobile Foundation Application Center: mfpappcenter
          ​

        Prerequisites

        ​

        • Red Hat OpenShift cluster 4.3.x (and above) on IBM Cloud
        • IBM Db2 v11.5 database. Create a supported database and keep the database access details handy for further use. For more information, see here.
        • Mobile Foundation Analytics requires mounted storage volume for persisting Analytics data (File Storage recommended).
        • Access to Entitled Registry (ER) for pulling the Mobile Foundation images.
          ​

        Installation steps

        ​
        Mobile Foundation can be deployed from the IBM Cloud catalog by setting the necessary deployment values.
        ​

        1. Choose the target OpenShift cluster from the drop-down.

        2. Set the project name to be used for the Mobile Foundation deployment. (It is created if doesn't exist already).

        3. Specify the Workspace name.

        4. Go to the deployment values section at the bottom of the page, ensure that the database details are set for the following deployment values.
          ​

          • db_host
          • db_port
          • db_name
          • db_userid
          • db_password

          Note: Supported db_type is DB2 only.
          ​

        5. Expand the deployment values with default values section, choose components to be enabled to set up Mobile Foundation.
          ​
          Ensure that the required components are enabled under the deployment values section. By default, all components are enabled. Set mfpxxxx_enabled to false to disable components like push, liveupdate, analytics_recvr, analytics, or appcenter.
          ​

        6. You can choose to set various other deployment values for a customized deployment like adding console secrets, name of the storage class, or persistent volume claim name for analytics.
          ​
          For a list of deployment values for Mobile Foundation, see here.

        7. Click Install to start the deployment, the page gets redirected to the IBM Schematics workspace for viewing the progress of the installation through logs.
          ​

        Note: This installation can take around 10-15 minutes to complete. After the installation begins, you can track the process by going to Apply logs in the new workspace or the Red Hat OpenShift cluster console.
        ​

        Advanced customization

        ​
        To set the custom TLS secret, truststore, keystore, configuration, etc., you need to have them created before the deployment and set the appropriate deployment values before installation. Following documentation links, provide the steps for the same.
        ​

        Update steps

        ​
        To update an existing deployment, make sure that a new workspace name is specified. You need to add the new deployment values and follow the installation steps again to update the previously deployed Mobile Foundation.
        ​

        Note: For update activity, a new schematics workspace must be used. (Refer to step 3 under Installation steps section.)
        ​

        Uninstall steps

        The following are the steps to uninstall the Mobile Foundation deployment.
        ​

        1. Go to IBM Schematics Workspace to view all the Mobile Foundation deployment workspaces.
        2. Locate the Workspace associated with the installation to be removed.
        3. Click the more options icon ⋮ on the right of the selected workspace.
        4. Select Delete.
        5. On the modal dialog, ensure both the options are checked - Delete workspace and Delete all associated resources.
        6. Follow the instructions on the dialog box and click Delete to remove the Mobile Foundation deployment from the cluster.
          ​

        Note: Uninstall removes all the resources that are created during the deployment. If the name of the Analytics storage class was used, make sure you note down the persistent volume that is used by the deployment.