Deployment and Swagger documentation

Starting with version 4.0.6, the FTM deployment has been reimagined to a solution-based architecture orchestrated with a single lightweight Go-based Red Hat OpenShift operator that supports independent versions on a single cluster. Sub-topics are dedicated to understanding the deployment architecture and how to plan your infrastructure according to your specific business needs. The steps that are needed to deploy your FTM offering to Red Hat OpenShift are shown in the following list. When you are ready to start deploying your FTM offerings, see Deploy to Red Hat OpenShift.

1. Review the hardware and software requirements to prepare for installation and deployment. For more information, see FTM Hardware and Software requirements.
2. Review the release information and other support documentation for your FTM offering. The support documentation contains information about any new features or known issues for the offering. Links to the support documentation are in the related information section at the end of the topic.
3. Collect any configuration information that you might need for the deployment. For example, database connectivity information, usernames and passwords, and other information.
4. Verify that your Red Hat OpenShift cluster is ready to be used for your FTM installation. Ensure that you have administrator access to the cluster.
   • You also need to install the Red Hat OpenShift Container Platform command-line interface (CLI) to interact with the Red Hat OpenShift Container Platform. For more information about the Red Hat OpenShift CLI, see CLI tools in the Red Hat OpenShift Container Platform documentation.
5. If your Red Hat OpenShift cluster does not have access to an external network, you can install in an air gap environment to get the container images for the FTM offerings. You also need to use the air gap instructions for prerequisite software such as IBM® MQ. The following list shows the air gap methods that are available for you to use for FTM.
   • Installing FTM in an air gap environment
6. Several tasks, such as the tasks in the following list, need to be done before you install the Red Hat OpenShift operator for the FTM offerings.
   • Install the IBM Cloud Pak foundational services operator and its IBM License Service operand.
   • Create and configure the network storage. For example, configuring the storage class.
   • Ensure that you have a software load balancer, such as HAProxy, available.
   • To avoid process-related issues, the process limit for each of the worker nodes in the Red Hat OpenShift Container Platform cluster must be at least 4096.
   • Configure mirroring for the cluster.
   • Add the IBM operator catalog.
7. Create or set up the Red Hat OpenShift namespace to use for your FTM offerings.
8. Create a secret that the cluster can use to get the secured container images that it needs.
9. If you want to use IBM MQ, install it now. You can use the IBM MQ operator or you can use an external IBM MQ instance.
10. If you want to use IBM App Connect, install the operator.  You do not need to install the IBM App Connect Operator for FTM Check.
11. If you want your database on Db2® Universal Container (Db2U), install, configure, and deploy Db2 on Red Hat OpenShift.
12. Install the FTM Red Hat OpenShift operator. The following offerings can be deployed on Red Hat OpenShift.
    • FTM
    • FTM CBPRPlus
    • FTM Check
    • FTM Common Services
    • FTM CPA AFT
    • FTM NACHA
    • FTM Nordic RTGS Systems
    • FTM SCT Inst
    • FTM T2/EURO1
    • FTM The Clearing House Real Time Payments
    • FTM Zelle
13. Create the artifacts for your selected FTM offering. The artifacts pod contains the files that are needed for the offering. For example, the files that are needed to create the FTM database.
14. If you want your Db2 database to be external to the cluster, install and configure it now. For example, you might need to install a new or migrate an existing external database.
15. If you are deploying any of the offerings in the following list, install and run the data setup utility (DSU) to import the configuration data for the necessary Common Services components.
    • FTM CBPRPlus
    • FTM Check
    • FTM Common Services
    • FTM CPA AFT
    • FTM NACHA
    • FTM Nordic RTGS Systems
    • FTM SCT Inst
    • FTM T2/EURO1
    • FTM The Clearing House Real Time Payments
    • FTM Zelle
16. The following offering-specific, predeployment configuration tasks use files that you retrieve from the artifact container for the offering.
    1. Map the persistent volumes to the network storage that you created. For example, create mount points in your NFS V4 storage and then map the persistent volumes to the mount points.
    2. Create custom certificates.
    3. Create an application secret for your FTM installation on Red Hat OpenShift.
    4. If signature verification of images is not configured for your Red Hat OpenShift cluster, add the public key for the signed images for your FTM offering.
17. Deploy the Red Hat OpenShift instance for your selected FTM offering.
18. Add the certificate for the IBM License Service operand to the FTM keystore.
19. Enable and configure TLS for the Java™ applications such as Business Rules Server. You do not need to do this step when you are deploying only FTM base.
20. Access the FTM components to verify the deployment.