Administering and operating IBM Process Federation Server Containers
IBM® Process Federation Server is a component for IBM Business Automation Workflow (BAW) and IBM Business Process Manager (BPM) environments. This component creates a federated process environment that provides business users with a single point of access to their task list and launch list, regardless of the type of process that they are working on and the BAW and / or BPM back-end system on which the process artifacts are stored.
When IBM Business Automation Workflow traditional offering is deployed on-premises, IBM Process Federation Server is an optional component that is extensively documented in the IBM Business Automation Workflow Knowledge Center.
When IBM Business Automation Workflow containers are deployed on Red Hat Openshift Container Platform or other CNCF Kubernetes platforms, Process Federation Server containers are also automatically deployed in order to provide a federated process environment that can be configured to federate on-premises Business Automation Workflow systems (V18.0.0.1 or later) with the Business Automation Workflow containers runtimes.
For information about installing Business Automation Workflow on containers, see:
- for stand-alone IBM Business Automation Workflow on containers: Containers: Installing, configuring, and migrating IBM Business Automation Workflow;
- for IBM Business Automation Workflow deployment with IBM Cloud Pak for Business Automation: Installing IBM Cloud Pak for Business Automation
The instructions for stand-alone IBM Business Automation Workflow on containers are similar to the instructions for the Business Automation Workflow Server (or Workflow Runtime) in the IBM Cloud Pak for Business Automation, and they both involve the creation of a Custom Resource of the ICP4ACluster kind. This Custom Resource is referenced as the ICP4ACluster Custom Resource in this Process Federation Server containers documentation.
Since IBM® Cloud Pak for Business Automation (CP4BA) 22.0.1, Process Federation Server can be installed separately without BAW. For information about installing Process Federation Server separately, see installing Process Federation Server Deployments
Documentation index
-
Architecture of a Process Federation Server container environment
When Process Federation Server is deployed using an ICP4ACluster Custom Resource, several kubernetes resources are created. The topics in this section provide detailed information about those resources.
-
Process Federation Server statefulset
Process Federation Server is deployed as a statefulset named
<icp4acluster-instance-name>-pfs. This section provide detailed information about this statefulset, how to access its REST API and how to configure it. -
Defining a federated data repository for Process Federation Server containers
Process Federation Server uses a remote federated data respository, implemented with an Elasticsearch or Opensearch cluster, to store data. The topics in this section provide detailed information about the different types of Elasticsearch or Opensearch clusters that can be used by PFS containers to implement the federated data repository, depending on the type of IBM Business Automation Workflow containers installation:
-
Using an Elasticsearch cluster provided by IBM Cloud Pak foundational services
When deploying IBM Business Automation Workflow containers with IBM Cloud Pak for Business Automation, by default, the ICP4ACluster Custom Resource is configured to provision and use an Elasticsearch cluster provided by IBM Cloud Pak foundational services. This section provides information about using this type of Elasticsearch cluster as the Process Federation Server federated data repository.
-
When deploying stand-alone IBM Business Automation Workflow on containers on AMD64 architectures, by default the ICP4ACluster Custom Resource is configured to create a statefulset,
<icp4acluster-instance-name>-elasticsearch-statefulset, that deploys pods running Elasticsearch. This option is not supported on other architectures. This section provide information about using this type of Elasticsearch cluster. -
Referencing your own Elasticsearch or Opensearch cluster
Instead of using Elasticsearch as part of the stand-alone IBM Business Automation Workflow on containers deployment or the IBM Business Automation Workflow Server (or Workflow Runtime) in the IBM Cloud Pak for Business Automation deployment, you can decide to reference your own Elasticsearch or Opensearch cluster. This section provide information about referencing this type of clusters.
-
-
-
Specifying Process Federation Server user authorizations on Kubernetes
When Process Federation Server is installed as part of the ICP4ACluster Custom Resource, the operator defines a default set of authorizations for Process Federation Server users, that you can customize depending on your needs. This section provides detailed information about that.
-
Federating IBM Business Automation Workflow running on-premise
You can configure IBM Process Federation Server containers to federate on-premise IBM Business Automation Workflow or IBM Business Process Manager systems. This section provides detailed information about that.
-
The case management tools provide support for indexing case instances in a federated data repository index. Full reindexing and live index updates are supported. This section provides detailed information about that.
-
Migrating saved searches to a new federated data repository
Process Federation Server Containers stores federated saved searches in an index of the federated data repository. To migrate from one federated data repository to another, you need to migrate existing saved searches. This section provides detailed information about that.
-
Maintaining, monitoring and troubleshooting IBM Process Federation Server in a container environment
You can maintain and monitor IBM Process Federation Server containers, and troubleshoot issues by following the procedures in this section.
-
Rebuilding federated systems indexes
If you want to delete a federated data repository index containing data from a federated system, you can use the procedure documented in this section, that does not require you to restart any pod.
-
Monitoring IBM Process Federation Server
You can monitor a running server to gather information, detect issues, and perform actions without having to restart the server. This section provides detailed information about that.
-
Troubleshooting Process Federation Server in a container environment
If you face any issue with Process Federation Server, you can reach IBM support which will ask you to set up relevant logs and gather these logs and information about your configuration. This section provides detailed information about gathering logs and information for troubleshooting and support.
-