Capabilities for production deployments

You can install one or more capabilities in a production deployment. Depending on the selected capabilities, or patterns, the needed components of the foundation pattern and IBM Automation foundation are also installed.

You can install the following capabilities with the deployment script or the Form View in the OpenShift Container Platform (OCP) console. The templates that are used for the installation, can be found in the cert-kubernetes/descriptors/patterns folder. For more information about downloading cert-kubernetes, see Preparing a client to connect to the cluster.

Depending on the selected capabilities, the needed components of the foundation pattern are installed. The final custom resource file can combine capabilities and components and any number of configuration parameters that you need to complete your customizations.

The operator catalog for Workflow Process Service is installed when the Cloud Pak operator catalog is installed, but you can create a deployment instance only after you created a IBM Cloud Pak® for Business Automation deployment. For more information, see Installing Workflow Process Service deployments.

Important: Use the list of capabilities and the dependencies to take note of what you need to prepare for on your cluster. Even if you select a single capability, you must prepare your cluster for the components that are always installed from the foundation. If you select extra components, they might not be in the same pattern and they might have dependencies of their own.

Whether the dependency is a capability or components within a capability you must prepare them all before you install a deployment. Preparation might include creating databases, users and groups (LDAP), secrets, and other types of storage.

Foundation (pattern name foundation)

The deployment of any Cloud Pak for Business Automation capability includes the foundation pattern.

Foundation pattern visual
Table 1. Foundation components
Components Installed
IBM Business Automation Navigator (BAN) Always
Resource Registry (RR) Always
Business Automation Insights (BAI) If selected by combined capabilities, and installed by the Insights Engine operator
Business Automation Studio (BAS), which requires Business Automation Insights (BTS) from Automation foundation. If needed by combined capabilities
Application Engine (AE) If needed by combined capabilities
Note: The foundation pattern for a production deployment also includes configurations for LDAP, databases, and initialization.

A deployment of the Cloud Pak custom resource also includes an instance of IBM Automation foundation and the foundational services. Depending on the capabilities that you select, the dependency operators create the service instances.

IAf visual
Table 2. Automation foundation components
Components Installed
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Automation Insights (BAI) If selected by combined capabilities
When the optional Business Automation Insights component is selected for deployment, the patterns activate the event processors.
  • Pattern ‘workflow’ or ‘workstreams’ activates the bpmn and icm processors for Business Automation Workflow and Case Manager events.
  • Pattern ‘decisions’ activates the odm processor for Operational Decision Manager events.
  • Pattern ‘content’ activates the content processor for IBM FileNet® Content Manager events.
Automation Foundation Event Processing (AutomationBase) If BAI is a selected option
Business Teams Service (BTS) If BAS is needed by selected capabilities
IBM Process Mining (IPM) Independently
IBM Robotic Process Automation (IRPA) Independently

Foundational services connect all IBM Cloud Paks with Operand Deployment Lifecycle Manager (ODLM) and use a specific namespace (ibm-common-services) to manage the service instances. IBM Automation foundation includes a number of components, some of which are always installed, others are installed if they are selected or needed, and IBM Process Mining and IBM Robotic Process Automation are installed only if you install them independently. For more information, see IBM Cloud platform foundation and IBM Automation foundation system requirements.

The components can be created with varying sizes and replicas with the deployment profile size you choose for your Cloud Pak deployment. By default, they are set for a minimum configuration. For a true production environment, you need to adjust the sizes of these requirements. For example, you might need to increase the number of elastic nodes to handle the load of the log storage. For more information about these configuration values, see Configuring IBM Cloud Pak foundational services by using the CommonService custom resource.

Note: You do not need to prepare for the Cloud Pak foundational services that are always installed. The Cloud Pak for Business Automation operator takes care of these services for you. If you want to install optional components, then you must check the preparing steps for all the options that you want to include in your deployment.

Automation Decision Services (pattern name decisions_ads)

ADS pattern visual
Table 3. Automation Decision Services components
Components Capability or pattern Installed
Decision Designer Automation Decision Services Optional
Decision Runtime Automation Decision Services Optional
MongoDB MongoDB Atlas Database When explicitly enabled (mongo.use_embedded=true)
Business Automation Insights (BAI) Foundation Optional
Business Automation Studio (BAS) and Business Teams Service (BTS) Foundation Optional. Installed when Decision Designer is selected
Application Engine Foundation Optional. Installed when Decision Designer is selected

The following foundation components are always installed and combined with Automation Decision Services.

Table 4. Installed foundation components with Automation Decision Services
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always

Automation Document Processing (pattern name document_processing)

document_processing pattern visual
Table 5. Automation Document Processing components: development environment (optional)
Components Capability or pattern Installed
Document Processing Designer interface and REST API Automation Document Processing Always
Document Processing Designer Repository API Automation Document Processing Always
Document Processing Project Deployment Service Automation Document Processing Always
Viewer service Automation Document Processing Always
Common Git Gateway Service Automation Document Processing Always
Content Analyzer Automation Document Processing Always
Content Platform Engine FileNet Content Manager Always
Content Services GraphQL API FileNet Content Manager Always
MongoDB MongoDB Atlas Database Always
External Share (ES) FileNet Content Manager Optional
Content Search Services (CSS) FileNet Content Manager Optional
Content Management Interoperability Services (CMIS) FileNet Content Manager Optional
Task Manager (TM) FileNet Content Manager Optional

The following foundation components are always installed and combined with Automation Document Processing (development).

Table 6. Installed foundation components with Automation Document Processing (development)
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Business Automation Studio (BAS) Always
Application Engine (AE) (data persistence optional) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Teams Service (BTS) Always
document_processing pattern visual
Table 7. Automation Document Processing components: runtime environment (optional)
Components Capability and pattern Installed
Content Project Deployment Service Automation Document Processing Always
Viewer Service Automation Document Processing Always
Content Analyzer Automation Document Processing Always
Content Platform Engine FileNet Content Manager Always
GraphQL API FileNet Content Manager Always
External Share (ES) FileNet Content Manager Optional
Content Search Services (CSS) FileNet Content Manager Optional
Content Management Interoperability Services (CMIS) FileNet Content Manager Optional
Task Manager (TM) FileNet Content Manager Optional

The following foundation components are always installed and combined with Automation Document Processing (runtime).

Table 8. Installed foundation components with Automation Document Processing (runtime)
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Application Engine (AE) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always

Automation Workstream Services (pattern name workstreams)

Automation Workstream Services visual
Table 9. Automation Workstream Services components
Components Capability or pattern Installed
Process Federation Server (PFS) Automation Workstream Services Always
Workflow server (JMS included) Automation Workstream Services Always
Content Platform Engine FileNet Content Manager Always
GraphQL API FileNet Content Manager Always
Content Management Interoperability Services FileNet Content Manager Always

The following foundation components are always installed and combined with Automation Workstream Services.

Table 10. Installed foundation components with Automation Workstream Services
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Application Engine (AE) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Teams Service (BTS) Always
Elasticsearch Always

Business Automation Application (pattern name application)

Business Automation Application visual
Table 11. Business Automation Application components
Components Capability or pattern Installed
Application Designer Business Automation Application Optional
Application Engine Data Persistence Business Automation Application Optional
Content Platform Engine FileNet Content Manager Optional. Required to use Application Engine data persistence.
GraphQL API FileNet Content Manager Optional. Required to use Application Engine data persistence.
Business Automation Studio (BAS) Foundation Optional. Installed when Application Designer is selected.

The following foundation components are always installed and combined with Business Automation Application.

Table 12. Installed foundation components with Business Automation Application
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Application Engine (AE) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Teams Service (BTS) Always

Business Automation Workflow (pattern name workflow)

You can choose Business Automation Workflow Authoring or Business Automation Workflow Runtime.

Workflow Authoring and Workflow Runtime must be in different instances (different custom resource and namespaces).

Business Automation Workflow Authoring
Business Automation Workflow visual
Table 13. Business Automation Workflow Authoring components
Components Capability or pattern Installed
Workflow server (JMS included) Business Automation Workflow Authoring Always
Process Federation Server (PFS) Business Automation Workflow Authoring Always
Content Platform Engine FileNet Content Manager Always
Content Management Interoperability Services FileNet Content Manager Always
GraphQL API FileNet Content Manager Optional. Required to use Application Engine data persistence.
Business Automation Insights (BAI) Foundation Optional. Machine Learning Server is available only if Business Automation Insights is installed.

The following foundation components are always installed and combined with Business Automation Workflow Authoring.

Table 14. Installed foundation components with Business Automation Workflow Authoring
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Application Engine (AE) (data persistence optional) Always
Business Automation Studio (BAS) (Playback Application Engine and JMS included) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Teams Service (BTS) Always
Elasticsearch Always
Business Automation Workflow Runtime
Workflow runtime pattern visual
Table 15. Business Automation Workflow Runtime components
Components Capability or pattern Installed
Workflow server (JMS included) Business Automation Workflow Runtime Always
Process Federation Server (PFS) Business Automation Workflow Runtime Always
Content Platform Engine FileNet Content Manager Always
Content Management Interoperability Services FileNet Content Manager Always
GraphQL API FileNet Content Manager Always
Business Automation Insights (BAI) Foundation Optional. Machine Learning Server is available only if Business Automation Insights is installed.

The following foundation components are always installed and combined with Business Automation Workflow Runtime.

Table 16. Installed foundation components with Business Automation Workflow Runtime
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Application Engine (AE) (data persistence required) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always
Business Teams Service (BTS) Always
Elasticsearch Always

FileNet Content Manager (pattern name content)

FNCM pattern visual
Table 17. FileNet Content Manager components
Components Capability or pattern Installed
Content Platform Engine (CPE) FileNet Content Manager Always
Content Services GraphQL FileNet Content Manager Always
Content Search Services (CSS) FileNet Content Manager Optional
Content Management Interoperability (CMIS) FileNet Content Manager Optional
Content Collector for SAP (ICC4SAP) FileNet Content Manager Optional
Enterprise Records (IER) FileNet Content Manager Optional
External Share (ES) FileNet Content Manager Optional
Task Manager (TM) FileNet Content Manager Optional
Business Automation Insights (BAI) Foundation Optional

The following foundation components are always installed and combined with FileNet Content Manager.

Table 18. Installed foundation components with FileNet Content Manager
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always

Operational Decision Manager (pattern name decisions)

ODM pattern visual
Table 19. Operational Decision Manager components
Components Capability or pattern Installed
Decision Center Operational Decision Manager Optional
Decision Runner Operational Decision Manager Optional
Decision Server Runtime Operational Decision Manager Optional
Business Automation Insights (BAI) Foundation Optional
Decision Server Console Operational Decision Manager When Decision Server Runtime is selected
Rule Designer Operational Decision Manager Independently

The following foundation components are always installed and combined with Operational Decision Manager.

Table 20. Installed foundation components with Operational Decision Manager
Components Installed
Resource Registry (RR) Always
Business Automation Navigator (BAN) Always
Default foundational services, which include
  • IBM Cloud Pak Platform UI (or Zen UI)
  • MongoDB
  • Identity and Access Management (IAM)
  • Common Web UI Service
  • License Service
  • Certificate management
 Always