Skip to content

IBM MobileFirst Platform Foundation on IBM Containers - Process Steps

Create Databases

Based on the number of projects placed under /usr/projects folder, which is part of the artifacts directory, this step iteratively creates the Admin and Runtime databases. The database is created as a service in IBM Bluemix and bound to a IBM Bluemix Application.

NameTypeDescriptionRequired
Admin Schema NameStringDatabase schema name (defaults to WLADMIN)No
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that should be bound to the containerYes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
DB Service Name in the BluemixStringBluemix database service instance nameYes
DB Service PlanStringBluemix database service planYes
DB Type (sqldb or cloudantNoSQLDB)StringType of the DB for IBM MobileFirst Platform Foundation to usesqldb or cloudantNoSQLDB are acceptedYes

Create Server Container (Create database, Prepare, Push and Start Container)

Create the IBM MobileFirst Platform Foundation container in IBM Bluemix as a single stepCreate the admin and runtime databases, Prepare the image, Push the image to the IBM Bluemix container image registry, Start the container

NameTypeDescriptionRequired
Admin Schema NameStringDatabase schema name (defaults to WLADMIN)No
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that should be bound to the containerYes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
DB Service NameStringBluemix database service instance nameYes
DB Service PlanStringBluemix database service planYes
DB Type (sqldb or cloudantNoSQLDB)StringType of the DB for IBM MobileFirst Platform Foundation to usesqldb or cloudantNoSQLDB are acceptedYes
Enable SSH?BooleanEnable SSH for the container. Accepted values are Y or NNo
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringIBM MobileFirst Platform Foundation properties as comma-separated key:value pairsNo
Expose HTTP?BooleanExpose HTTP Port. Accepted values are Y or NNo
Expose HTTPS?BooleanExpose HTTPS Port. Accepted values are Yor NNo
Maximum Log File SizeStringMaximum size of a log fileNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
SSH KeyStringSSH Key to be injected into the containerNo
Server Container NameStringName of the IBM MobileFirst Platform Foundation container to be createdYes
Server IPStringIP address that the IBM MobileFirst Platform Foundation container should be bound to.Yes
Server Image TagStringTag to be used for tagging the IBM MobileFirst Platform Foundation imageYes
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be applied to IBM MobileFirst Platform FoundationNo

Create Server Container Group (Create database, Prepare, Push and Start Container Group)

Create the IBM MobileFirst Platform Foundation container group in IBM Bluemix as a single stepCreate the admin and runtime databases, Prepare the image, Push the image to the IBM Bluemix container image registry, Start the container group.

NameTypeDescriptionRequired
Admin Schema NameStringDatabase schema name (defaults to WLADMIN)No
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that should be bound to the containerYes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
DB Service NameStringBluemix database service instance nameYes
DB Service PlanStringBluemix database service planYes
DB Type (sqldb or cloudantNoSQLDB)StringType of the DB for IBM MobileFirst Platform Foundation to usesqldb or cloudantNoSQLDB are acceptedYes
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringIBM MobileFirst Platform Foundation properties as comma-separated key:value pairsNo
Maximum Log File SizeStringMaximum size of a log fileNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
Server Container Group DesiredStringThe desired number of instancesYes
Server Container Group DomainStringThe domain name of the routeYes
Server Container Group HostStringThe host name of the routeYes
Server Container Group MaximumStringThe maximum number of instancesYes
Server Container Group MinimumStringThe minimum number of instances.Yes
Server Container Group NameStringName of the IBM MobileFirst Platform Foundation container groupYes
Server Image TagStringTag to be used for tagging the IBM MobileFirst Platform Foundation imageYes
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be applied to IBM MobileFirst Platform FoundationNo

Deploy Apps and Adapters

From the artifacts directory (/usr/projects folder), iteratively deploy all the apps and adapters in to the running IBM MobileFist Platform Foundation container runtime.

NameTypeDescriptionRequired
Certificate DirectoryStringDirecotory which stores the certificate bundle to verifyNo
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Server Admin PasswordPasswordPassword of IBM MobileFirst Platform Foundation administratorYes
Server Admin RootStringAdmin context path of the IBM MobileFirst Platform Foundation (worklightadmin)No
Server Admin UsernameStringUser name of IBM MobileFirst Platform Foundation administratorYes
Server IPStringIP address that the IBM MobileFirst Platform Foundation containerYes
Server Port (HTTPS)StringServer Port (HTTPS)Yes

Prepare and Push Analytics Image

Prepare the IBM MobileFirst Platform Foundation Operational Analytics Image and pushes it to the IBM Bluemix Container image registry to the corresponding organization and space.

NameTypeDescriptionRequired
Analytics Image TagStringTag to be used for tagging the analytics imageYes
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes

Prepare and Push Server Image

Prepares the IBM MobileFirst Platform Foundation Image and pushes it to the IBM Bluemix Container image registry to the corresponding organization and space.

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Server Image TagStringTag to be used for tagging the IBM MobileFirst Platform Foundation imageYes

Remove Existing Container

Removes the existing IBM MobileFirst Platform Foundation single node container (existing in any state).

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container NameStringName of the IBM MobileFirst Platform Foundation container to be removedYes

Remove Existing Container Group

Removes the existing IBM MobileFirst Platform Foundation container group (existing in any state).

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Group NameStringName of the IBM MobileFirst Platform Foundation container groupYes

Remove Server Runtime

Removes a specified runtime from a running IBM MobileFirst Platform Foundation container or container group on IBM Bluemix.It can also delete the runtime database, if selected.

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that is bound to the containerYes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Certificate DirectoryStringDirecotory which stores the certificate bundle to verifyNo
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
DB Service NameStringBluemix database service instance nameNo
Delete Runtime Data?BooleanConfirmation to delete the project-related dataNo
Liberty Admin PasswordPasswordPassword of the Liberty administrator roleYes
Liberty Admin UsernameStringUser name of the Liberty administrator roleYes
Runtime NameStringThe name of the runtime to be removedYes
Runtime Schema NameStringRuntime Schema NameNo
Server Admin PasswordPasswordPassword of IBM MobileFirst Platform Foundation administratorYes
Server Admin RootStringAdmin context path of the IBM MobileFirst Platform Foundation (worklightadmin)No
Server Admin UsernameStringUser name of IBM MobileFirst Platform Foundation administratorYes
Server IPStringThe IP address the IBM MobileFirst Platform Foundation container is bound to.Yes
Server Port (HTTPS)StringThe HTTPS port number exposed on the IBM MobileFirst Platform Foundation container.Yes

Start Analytics Container

Start IBM MobileFirst Platform Foundation Operational Analytics Container on IBM Bluemix, based on the configurations provided. This uses the image tag from the IBM Bluemix image registry to create the container.

NameTypeDescriptionRequired
Analytics Container NameStringName of the Container to be createdYes
Analytics Data DirectoryStringSpecify the directory to be used for storing analytics data.No
Analytics Data Volume NameStringSpecify name of the volume to be created and mounted for analytics data.No
Analytics IPStringIP address that the Analytics containerYes
Analytics Image TagStringTag to be used for tagging the analytics imageYes
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Enable Analytics Data Volume?BooleanEnable mounting volume for analytics data.No
Enable SSH?BooleanEnable SSH for the container. Accepted values are Y or NNo
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringProvide related IBM MobileFirst Platform Foundation Operational Analytics image properties as comma-separatedNo
Expose HTTP?BooleanExpose HTTP Port. Accepted values are Y or NNo
Expose HTTPS?BooleanExpose HTTPS Port. Accepted values are Yor NNo
Maximum Log File SizeStringMaximum Log File SizeNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
SSH KeyStringSSH Key to be injected into the containerNo
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be appliedNo

Start Analytics Container Group

Start the IBM MobileFirst Platform Foundation Operational Anlaytics Container Group on IBM Bluemix, based on the configurations provided. This uses the image tag from the IBM Bluemix image registry to create the container group.

NameTypeDescriptionRequired
Analytics Container Group DesiredStringAnalytics Container Group desired number of nodesYes
Analytics Container Group DomainStringAnalytics Container Group DomainYes
Analytics Container Group HostStringHostname for the Container Group to be createdYes
Analytics Container Group MaximumStringAnalyticsContainer Group maximum number of nodesYes
Analytics Container Group MinimumStringAnalyticsContainer Group minimum number of nodesYes
Analytics Container Group NameStringName of the Container Group to be createdYes
Analytics Data DirectoryStringSpecify the directory to be used for storing analytics data.No
Analytics Data Volume NameStringSpecify name of the volume to be created and mounted for analytics data.No
Analytics Image TagStringTag to be used for tagging the analytics imageYes
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Enable Analytics Data Volume?BooleanEnable mounting volume for analytics data.No
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringProvide related IBM MobileFirst Platform Foundation Operational Analytics image properties as comma-separatedNo
Maximum Log File SizeStringMaximum Log File SizeNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be applied to IBM MobileFirst Platform FoundationNo

Start Server Container

Start the IBM MobileFirst Platform Foundation Container on IBM Bluemix, based on the configurations provided. This uses the image tag from the IBM Bluemix image registry to create the container.

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that should be bound to the containerNo
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Enable SSH?BooleanEnable SSH for the container. Accepted values are Y or NNo
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringIBM MobileFirst Platform Foundation properties as comma-separated key:value pairsNo
Expose HTTP?BooleanExpose HTTP Port. Accepted values are Y or NNo
Expose HTTPS?BooleanExpose HTTPS Port. Accepted values are Y or NNo
Maximum Log File SizeStringMaximum size of a log fileNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
SSH KeyStringSSH Key to be injected into the containerNo
Server Container NameStringName of the IBM MobileFirst Platform Foundation container to be createdYes
Server IPStringIP address that the IBM MobileFirst Platform Foundation container should be bound to.Yes
Server Image TagStringTag to be used for tagging the IBM MobileFirst Platform Foundation imageYes
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be applied to IBM MobileFirst Platform FoundationNo

Start Server Container Group

Start the IBM MobileFirst Platform Foundation Container group (clustering) on IBM Bluemix, based on the configurations provided. This uses the image tag from the IBM Bluemix image registry to create the container group.

NameTypeDescriptionRequired
Bluemix API URLStringBluemix API endpoint. (https://api.ng.bluemix.net)Yes
Bluemix Application NameStringThe Bluemix application name that should be bound to the containerNo
Bluemix CCS HostStringIBM Containers Cloud Service Host (https://containers-api.ng.bluemix.net/v3)Yes
Bluemix OrgStringBluemix Organization to be usedYes
Bluemix PasswordPasswordPassword for Bluemix loginYes
Bluemix SpaceStringBluemix Space to be usedYes
Bluemix UserStringBluemix user ID or email addressYes
Container Artifacts FolderStringContainer Artifacts un-zipped locationYes
Enable Volume?BooleanEnable mounting volume for container logsNo
Environment PropertiesStringIBM MobileFirst Platform Foundation properties as comma-separated key:value pairsNo
Maximum Log File SizeStringMaximum size of a log fileNo
Maximum Log FilesStringMaximum number of log files to maintain before overwritingNo
Server Container Group DesiredStringThe desired number of instancesYes
Server Container Group DomainStringThe domain name of the routeYes
Server Container Group HostStringThe host name of the routeYes
Server Container Group MaximumStringThe maximum number of instancesYes
Server Container Group MinimumStringThe minimum number of instances.Yes
Server Container Group NameStringName of the IBM MobileFirst Platform Foundation container groupYes
Server Image TagStringTag to be used for tagging the IBM MobileFirst Platform Foundation imageYes
Server MemoryStringAssign a memory size limit to the container in megabytes (MB)Yes
Trace SpecificationStringTrace specification to be applied to IBM MobileFirst Platform FoundationNo

Un-Deploy Apps and Adapters from a Runtime

Apps and adapters provided with comma separated, are undeployed from the specified runtime, in the running IBM MobileFirst Foundation Platform Container.

NameTypeDescriptionRequired
Adapters (, separated)StringList of adapters to be un-deployed with , separatedNo
Apps (, separated)StringList of apps to be un-deployed with , separatedNo
Certificate DirectoryStringDirecotory which stores the certificate bundle to verifyNo
Server Admin PasswordPasswordPassword of IBM MobileFirst Platform Foundation administratorYes
Server Admin RootStringAdmin context path of the IBM MobileFirst Platform Foundation (worklightadmin)No
Server Admin UsernameStringUser name of IBM MobileFirst Platform Foundation administratorYes
Server IPStringIP address that the IBM MobileFirst Platform Foundation containerYes
Server Port (HTTPS)StringServer Port (HTTPS)Yes
Server Runtime NameStringRuntime that need to be modifiedYes