Package structure and contents

This topic contains important information about scripts and other contents of the MobileFirst Platform Foundation on IBM® Containers package (ibm-mfpf-container-7.1.0.0).

The MobileFirst Platform Foundation on IBM Containers package provides a means to build your custom MobileFirst applications and deploy them to IBM Containers on Bluemix®.

After you download the package, extract the contents to your development environment (to the ibm-mfpf-container-7.1.0.0 folder, also referred to in this document as package_root). The following tables contain descriptions of the top-level folders of the package offering.

Table 1. Top-level folders
Folder Description
dependencies Contains the IBM MobileFirst™ Platform Foundation runtime and IBM Java™ JRE 7.1.
mfpf-analytics Contains the artifacts required to build and deploy the MobileFirst Operational Analytics container.
mfpf-libs Contains MobileFirst product component libraries and CLI.
mfpf-server Contains the artifacts required to build and deploy a MobileFirst Server container.
Table 2. MobileFirst Operational Analytics container and MobileFirst Server container folders. The sub-folder names within the MobileFirst Operational Analytics container (mfpf-analytics) folder and MobileFirst Server container (mfpf-server) folder
Folder Description
scripts Contains the properties files and scripts for building and deploying the containers. Other than the customizable args/*.properties files, do not modify any elements in this folder.
usr Contains user-configurable elements, such as keystores, properties, registry, and projects. Elements in this folder can be modified but not deleted.

Scripts

The scripts provided build and run the MobileFirst Operational Analytics container image and MobileFirst Server container image as containers.

Scripts can only be run from within the scripts folder. Do not modify the given folder structure.

The following methods are supported for passing parameters to the scripts:
  • Command-line arguments (Usage: scriptname.sh [-command|--command] ARGUMENT)
  • Interactive method (By running the script with no command-line arguments.)
  • Properties files (By customizing the related args/*.properties files.)
    You can find information about the required and optional arguments in the properties files, such as the default values, input descriptions, and so forth. The script properties files are located in the following folders in the package_root/:
    • mfpf-analytics/scripts/args
    • mfpf-server/scripts/args

    Example command execution usage: prepareserver.sh args/prepareserver.properties

For script usage help, use the -h or --help command-line arguments (for example, scriptname.sh --help).