Package structure and contents

For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Package structure and contents

The V8.0.0 ibm-mfpf-container-8.0.0.0.zip package unpacks to the scripts and other necessary contents that deploy to IBM® Bluemix.

The V8.0.0 package provides the means to build your custom MobileFirst applications and deploy them to IBM Containers on Bluemix®.
After you download the package, extract the contents to our development environment to the ibm-mfpf-container-8.0.0.0.zip folder, also referred to as package_root in this document. The following tables contain descriptions of the top-level folders of the package offering.

Folders

Table 1. Top-level folders
Folder Description
dependencies Contains the IBM MobileFirst™ Platform Foundation runtime and IBM Java™ JRE 8.
mfpf-analytics Contains the artifacts required to build and deploy the MobileFirst 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.
mfpf-server-libertyapp Contains the artifacts required to build and deploy a MobileFirst Server as Liberty for Java Cloud Foundry application.

Table 2. MobileFirst Analytics container and MobileFirst Server for Cloud Foundry and container folders. The subfolder names within the MobileFirst Analytics container mfpf-server and MobileFirst Server container mfpf-server folder
Folder Description
scripts Contains the properties files and scripts for building and deploying MobileFirst Server as a Cloud Foundry application or deploying in the IBM Containers and for deploying MobileFirst Analytics in IBM 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 build and run:
MobileFirst Server as Liberty for Java Cloud Foundry application
MobileFirst Server in IBM Containers
MobileFirst Analytics in IBM 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.)
We 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-server-libertyapp/scripts/args
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).

Parent topic: IBM MobileFirst Platform Foundation on cloud


Folder	Description
dependencies	Contains the IBM MobileFirst™ Platform Foundation runtime and IBM Java™ JRE 8.
mfpf-analytics	Contains the artifacts required to build and deploy the MobileFirst 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.
mfpf-server-libertyapp	Contains the artifacts required to build and deploy a MobileFirst Server as Liberty for Java Cloud Foundry application.


Folder	Description
scripts	Contains the properties files and scripts for building and deploying MobileFirst Server as a Cloud Foundry application or deploying in the IBM Containers and for deploying MobileFirst Analytics in IBM 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.