IBM Support

Move FileNet Content Manager to Cloud Pak for Business Automation

How To


Summary

Following the steps in this guide, you can transform and modernize your FileNet Content Manager environment with the latest in container-based technology. IBM Cloud® Paks are AI-powered software for hybrid cloud that can help you accelerate digital transformation.

Objective

To move or replatform your FileNet Content Manager environment to the Cloud Pak, follow these high-level steps:
•    Get started
•    Assess your readiness
•    Prepare your source FileNet Content Manager environment for the move
•    Prepare your target Cloud Pak environment for the move
•    Move FileNet Content Manager to the Cloud Pak
•    Optionally modernize your environment

Environment

Source platform: IBM FileNet Content Manager on traditional WebSphere Application Server
Target platform: IBM Cloud Pak for Business Automation 20.0.3 and later in a container deployment
Database server: Db2, Oracle

Steps

Get started

In the IBM Cloud Pak for Business Automation, the content pattern deploys a containerized version of IBM FileNet Content Manager, providing core business automation capabilities that can manage and govern large amounts of content.

The change from a traditional application server environment to the Cloud Pak environment involves planning and preparation. The IBM Cloud Pak for Business Automation documentation provides the requirement and planning information you need to get started. Read through the planning, installation, and using sections to understand what the environment entails. 

Use the information in Planning for an Enterprise installation to plan for a Cloud Pak environment.

Assess your readiness

At the start of your transformation journey, assess your current readiness of adopting IBM Cloud Pak for Business Automation.

Deploying products in a container environment can be faster and easier than a standard traditional WebSphere Application Server installation. Additionally, updating software in a container environment can be simpler and less disruptive. You might want to choose a container deployment if you want better resource usage and management, better resiliency for your applications, and expanded capabilities through integration with other Cloud Pak offerings.

If you have any of the following requirements, you might want to choose or maintain a standard traditional WebSphere Application Server installation:

  • Your platform and software choices are currently not supported by the container platform. For more information, see the Software and Product Compatibility Report.
    • You use database or LDAP software versions that are not supported by the container platform.
    • You use IBM Content Collector for email integration with Content Search Services.
    • You use the IBM Spectrum Protect fixed content device for Content Platform Engine storage.
  • You use custom applications that use the Content Platform Engine EJB protocol.
  • You use Content Platform Engine Virtual Member Manager directory configuration. VMM is not supported by WebSphere Liberty.

If your software choices, for example, LDAP server version, are not supported, and you want to continue with the move, update your supporting software before you start the move or upgrade.

If you decide to move your traditional WebSphere Application Server deployment of FileNet Content Manager to the Cloud Pak for Business Automation, consider the following scenarios:

Move Scenarios
Your Chosen Scenario Follow This Path
Upgrade from a V5.2.x or V5.5.x traditional WebSphere Application Server environment to a container deployment in the Cloud Pak.
Option 1 (Best practice): Upgrade your traditional WebSphere Application Server installation, including updating your database and directory server software to the supported versions, with FileNet Content Manager V5.5.6 or later deployed to the traditional WebSphere Application Server. After the upgrade is complete, move to the Cloud Pak container deployment, and decommission your traditional WebSphere Application Server deployment. This method separates the two changes (upgrading and moving to containers) in case you need to troubleshoot issues.
 
Option 2: Perform your deployment as an upgrade. 

In both options, all systems and data are upgraded to the new Cloud Pak container-based version, and only container-based interactions are supported. 
Keep your traditional WebSphere Application Server installation and introduce components of the same version that are deployed in the Cloud Pak.
Applies for V5.5.6 and later. All components must be on the same version and can share access to the same back-end data:
- Use traditional WebSphere Application Server Navigator or other IBM component or client installation against the traditional WebSphere Application Server Content Platform Engine.
- Use the Cloud Pak/container-deployed Navigator, other IBM component, or other client installation against the Cloud Pak or container-deployed Content Platform Engine. 
Upgrade to a higher version in the Cloud Pak, but keep your current installed traditional WebSphere Application Server version. Not supported. When the data is connected to the container deployment, it is upgraded to the new version.
Move from your earlier container-deployed version on another Kubernetes platform to the latest Cloud Pak on an OpenShift Cloud Platform deployment. Set up your OpenShift Cloud Platform cluster and operator, prepare for deployment, enter all the values for your existing back-end data and systems into your custom resource file, and apply the custom resource file. Your environment is updated to the latest version and deployed into the Cloud Pak, and replaces your other container environment.

The following components are available for inclusion in a container or Cloud Pak environment:

  • Content Platform Engine
  • Content Search Services
  • Content Management Interoperability Services
  • External Share
  • Content Services GraphQL API
  • Content Navigator, called Business Automation Navigator in the Cloud Pak
  • Task Manager

For this move of your deployment to the Cloud Pak, your data remains in the original location. Ensure that your container deployment is geographically near to your original data location. 

Prepare your source FileNet Content Manager environment for the move

The traditional WebSphere Application Server environment must be prepared to facilitate the move to the Cloud Pak container-based environment. In addition, the component containers need access to the existing directory server, database installation, and storage as well as new resources to support the content services containers.

Before you begin

Check the IBM® Software and Product Compatibility Report for hardware and system requirements as well as the appropriate versions of supporting software. Enter "Cloud Pak for Automation" in the search to see the relevant details for the 20.0.3 environment.

For more information on the Cloud Pak environment, see Planning an enterprise installation.

About this task

This task is a part of the process to move an existing P8 domain to be managed by a container deployment of the Content Platform Engine and associated components. If your FileNet P8 domain was already upgraded to a version that is supported for the move, certain preparation tasks that are described in this process are already accomplished and can be skipped as noted. Perform the remaining tasks that are relevant to the addition of containers to an existing FileNet P8 deployment.

Some tasks require input that results from other preparation tasks performed by other administrator roles. Plan to keep a record for use in other preparation and deployment activities.

FileNet® P8 requires a robust environment of integrated software, such as databases, Lightweight Directory Access Protocol (LDAP) servers, and components in the FileNet P8 family. This interdependence calls for preparation and collaboration with the administrators in your environment to configure the infrastructure and record the relevant details for the FileNet P8 installation and setup.

The steps you take to prepare can differ depending on your starting point and what components you want to include in your Cloud Pak environment.

Procedure

To prepare to introduce content services containers into an existing FileNet P8 system:
  1. Review the following security requirements for your systems:
    • Do not change realms (your authenticated users and groups), during a move or upgrade to containers.
    • Contact your IBM® FileNet® representative if you intend to change directory servers.
  2. (For upgrade moves) Prepare the database servers for the systems that are being upgraded to the Cloud Pak.

    Use the following information: Database administrator planning

  3. Ensure you have the JDBC driver files that are needed for the database version in an accessible location.
  4. If your FileNet P8 is already upgraded to the same release version as the targeted container deployment, you might want to copy the JDBC driver files from the system that performed the upgrade.

  5. As part of the plan to add containers to the existing FileNet P8 system or to upgrade a FileNet P8 system using containers, prepare the existing file servers for use with containers. For details, see Arranging your storage.
  6. (For upgrade moves) Use the following information to enable the asynchronous processing dispatcher to ensure that the object stores progress to a completed or ready state as part of an upgrade: Enabling the Asynchronous processing dispatcher. If your FileNet P8 domain is already upgraded to V5.5.1 or later, you can skip this step.
  7. (For upgrade moves) If the data will be upgraded by using the containers, provide the bootstrap information from the existing FileNet P8 Engine-ws.ear to the deployed containers.

    Important: If your FileNet P8 domain is already upgraded to V5.5.1 or later, you can skip this step.

    Locate and obtain a copy of the bootstrapped version of the EAR file for later use. If you used the P8 Configuration Manager tool to bootstrap the EAR file, the path to the file is as follows: Content_Platform_Engine_installation_directory\ContentEngine\tools\configure\profiles\profile_name\ear\Engine-ws.ear

    If you plan to deploy the Content Platform Engine container as an upgrade of a P8 domain to containers, use the following instructions to extract a required file from the Engine-ws.ear file:

    1. Choose an unzip or archive tool such as unzip to process the Engine-ws.ear file. If needed, you can install unzip:

      RedHat Enterprise Linux

      yum install unzip

    2. Extract the props.jar file from the following location in Engine-ws.ear: APP-INF/lib.

      The following example uses the unzip command to place the file into the /tmp directory of the machine where the command is run:

      unzip -j Engine-ws.ear APP-INF/lib/props.jar -d /tmp
      
    3. After you extract the props.jar file, place it into the directory that you created for the bootstrap persistent volume claim you will use for the Content Platform Engine container deployment.

Arranging your storage areas and index areas to meet container requirements

You can do this preparation in the WebSphere Application Server environment prior to the upgrade to reduce the time the production system is unavailable during the upgrade process. 

  • If necessary, rearrange the storage or use another technique to provide a single top-level directory.
    • One single top-level directory is required for the persistent volume definition that corresponds to the Content Platform Engine file store volume for the Content Platform Engine container deployment.
    • If you are deploying Content Search Services, another single top-level directory is needed for the persistent volume definition that corresponds to the index volume for content index data for the Content Search Services container deployment.
  • For existing file storage areas such as standard file stores and advanced storage area devices, and for index areas, the best practice is to have a single top-level directory for all file storage areas and another single top-level directory for all index areas. If this best practice setup was not followed in the traditional WebSphere Application Server environment, you must rearrange the storage or use other techniques to provide a single top-level directory.

  • Check the folder ownership to ensure that the top-level directories and all of the subfolders follow the storage permissions and ownership guidance in Configuring storage for the content services environment. This ownership enables the Content Platform Engine and Content Search Services containers to access the file system. If the WebSphere Application Server continues to run with the containers to manage the FileNet P8 domain, you must also add the user account that represents the Content Platform Engine Operating System User (cpe_os_user), formerly known as the Bootstrap User, on the WebSphere Application Server system to the owning group in the OpenShift Cloud Platform environment.

The following steps must be done for each object store.

To determine the setup of your storage areas:

  1. For each storage area that is associated with the object store, access the storage area properties.
  2. In the domain navigation pane of the administration console, click the object store.
  3. In the object store navigation pane, select the Administrative > Storage

    For Advanced Storage, open the Advanced Storage Devices folder.

    1. Open the File System Storage Devices folder.
    2. For each file system storage device, click the Configuration tab and note the value for the Root directory path. All relevant files and folders are located in this folder.

    For legacy file systems, open the Storage Areas folder.

    1. In the General tab for each storage area, note the value for the Root directory path. All relevant files and folders are located in this folder.

    For any fixed storage areas, note the location of the fixed content device and its staging area.

To determine your index area setup for Content Search Services:

  1. For each index area that is associated with the object store, access the index area properties.
  2. In the domain navigation pane of the administration console, click the object store.
  3. In the object store navigation pane, select the Administrative > Index Areas folder.
  4. In the General tab for each index area, note the location that is specified by the root directory. An index area can be on a local file system as opposed to a network-shared drive.
  5. On the Index tab, note the indexes that exist for the index area.

Gathering the values for your custom resource definition file

When you add a container deployment to an existing P8 domain, you follow the same procedures as for a container deployment in a new environment. However, you use the back-end support configuration and storage that already exists for your domain. Review and use the following guidelines when you fill in the custom resource definition YAML file.

Collect the values for your custom resource file, based on the existing supporting software in your traditional environment.

Use the following reference topics for more information:

Use existing LDAP server and database

The FileNet P8 components use an LDAP directory service to create and manage user and group accounts. However, the directory service is not a part of the FileNet P8 deployment. Most likely, it is on a separate and independent system shared by multiple applications. Provide connection and configuration information for the same LDAP service that is used by the existing WebSphere® Application Server managed FileNet P8 domain.

Locate the LDAP service connection information and bind user credentials. Note the values that are used to populate the ldap_configuration section of the custom resource file. Record values that are needed to create the LDAP secret later.

Important: If you are using the 2-LDAP approach for external share, you must also locate and record the settings for this second LDAP directory service.

Use one of the following methods to locate the information:

Method 1: Using the Administration Console for Content Platform Engine
  1. In the administration console, in the domain navigation pane, open the Directory Configuration tab.
  2. Click the name of the Directory Configuration object.
  3. Compare the information in the Directory Configurations Properties tab to the required parameters in the LDAP Configuration section of the shared configuration parameters portion of the custom resource file.
  4. Record the information needed for the required parameters in the ldap_configuration section of the custom resource file.
Method 2: Using Content Platform Engine Configuration Manager
  1. In Configuration Manager, open your configuration profile.
  2. Right-click Configure LDAP in the profile pane and click Edit Selected Task.
  3. Record the information needed for the required parameters in the ldap_configuration section of the custom resource file.
Method 3: Using the application server administration console
  1. In your application server console, view the information for the realm definition under the security area of the application server cluster information.
  2. Record the information needed for the required parameters in the ldap_configuration section of the custom resource file.

Data source names

Collect the data source and data source names and values that were used in your existing system. For more information on the required data source parameters, see Shared parameters.

Determining the location of the Global Configuration Database (GCD)

Use one of the following methods to determine the data source and data source names that were used when the global configuration database was created:

Method 1: Configuration Manager

In Configuration Manager, open your configuration profile and follow the next step based on the version of your current system.

Version 5.5.0 and earlier

  1. Right-click Configure Bootstrap Properties in the profile pane and click Edit Selected Task.
  2. Click View Bootstrapped EAR Information to display the bootstrap information from the EAR file.
  3. Note the values given for the GCD JDBC data source and XA data source names.

Version 5.5.1 and later

  1. Right-click Deploy Application in the profile pane and click Edit Selected Task.
  2. Note the values given in the GCD JDBC data source and XA data source name fields.
Method 2: Application server console In WebSphere Application Server, you find the information listed in the Resources > JDBC > Data sources section. The database information is listed with the General Properties for each data source.

Determining the location of the object store database

Determine the data source and data source names that were used when the object store was created:

  1. In the administration console in the domain navigation pane, click the object store.
  2. In the object store navigation pane, click the name of the object store (the top-level item).
  3. In the object store Properties tab, click the value for the database connection to open the database connection in a new tab.
  4. In the database connection General tab, note the values for the data sources that are used in the database connection.
In your application server console, view the information for the data source.

In WebSphere Application Server, you can find the information listed in the Resources > JDBC > Data sources section. The database information is listed with the General Properties for each data source. Record the information needed for the required secrets and parameters in the datasource_configuration section of the custom resource file.

Determining the location of the Navigator database

To determine the IBM Content Navigator database information:

  1. Log on to the IBM Content Navigator server as a user with access to the IBM Content Navigator Configuration and Deployment Tool.
  2. Right-click Configure Your Database and Data Source in the profile pane and click Edit Selected Task.
  3. Note the values given as needed for the required secrets and parameters in the datasource_configuration and navigator_configuration sections of the custom resource file.

Backing up the IBM Content Navigator configuration directory 

Back up the IBM Content Navigator configuration directory, including the primary cryptographic key. For more information, see this IBM Content Navigator Security Enhancement technical notice.

Preparing the target Cloud Pak environment for the FileNet Content Manager containers

Set up your cluster and prepare the new environment for the components that you want to deploy.

  1. Prepare the cluster.

    Follow the instructions to prepare your Kubernetes cluster to host your deployment, including preparing storage for the operator, getting access to your container images, and setting up the cluster and installing the operator.

  2. Prepare for the containers that you plan to include in your installation by using the following information in the Cloud Pak for Business Automation documentation.

Some of the steps in the Preparing to install topics might not apply to your situation. For example, tasks for creating a database assume that you are installing for the first time and must create a new database. In an upgrade or move to the Cloud Pak, you use the existing databases that were used by your traditional WebSphere Application Server version.

In other cases, you must perform the tasks for both new and upgrade or move deployments. For example, you must create the required PV and PVCs for each component if you plan to use manually created storage volumes.

Read each task carefully to determine whether you must complete it before you deploy your containers. If your source environment doesn’t include a component, you do not need to perform the preparation steps or include the container for that deployment in your environment.

Use the tasks under Preparing to install FileNet Content Manager and Preparing to install Business Automation Navigator to get your environment ready for the container deployment of your components.

FileNet Content Manager

FileNet Content Manager Preparation Task When To Do This Task
Preparing users and groups This task doesn't apply because your users and groups already exist in your source environment. Record the information from your existing LDAP configuration.
Configuring an identity provider connection This task applies in a move scenario only if you are using an identity provider for external share users. After your new deployment is set up, you can decide whether to add this capability to manage internal users.
Preparing the databases
This task doesn't apply in a move scenario because your databases are already configured to support your source environment. However, the additional tasks for creating secrets for SSL configuration data are required:
Creating secrets to protect sensitive FileNet Content Manager configuration data This task is required.
Configuring storage for the content services environment
Although your storage is already configured for the existing FileNet Content Manager source environment, read this topic to understand how storage works in the container environment. You already prepared and arranged your content storage for the move. However, you do need to create the PVs and PVCs for container deployment. Follow the instructions in Creating volumes and folders for deployment
For upgrades from 5.5.0 and earlier, the bootstrap persistent volume claim must be statically provisioned 
Preparing for external share If you configured external share in your source environment, you must prepare the target environment for the container-based configuration of this feature. 
Preparing volumes and folders for the GraphQL API container GraphQL is available for use in a container environment. If you want to add GraphQL to your environment, prepare the volumes and folders before you run the deployment, and be sure to include the GraphQL section in your deployment configuration.
Preparing for external key management If you manage encryption with external keys, or you want to add this approach, use these instructions to prepare.

Business Automation Navigator

Prepare for Navigator
Navigator Preparation Task When To Do This Task
Preparing users and groups  This task doesn't apply because your users and groups already exist in your source environment. Record the information from your existing LDAP configuration.
Preparing the database
This task doesn't apply in a move scenario because your databases are already configured to support your source environment.
If your scenario includes maintaining a traditional WebSphere Application Server deployment alongside the container deployment, you need an additional configuration database for Navigator in the container environment.
In addition, these tasks for creating secrets for SSL configuration data are required:
Creating secrets to protect sensitive Business Automation Navigator configuration data This task is required if your deployment includes Navigator.
Creating volumes and folders for deployment on Kubernetes
This task is required if your deployment includes Navigator. 
If moving IBM Content Navigator, verify the Navigator primary encryption key, backed-up as described in the section "Prepare your source FileNet Content Manager environment for the move," was copied to the persistent volume claim created for the IBM Business Automation Navigator Liberty configuration data. To do this before the Navigator container is deployed, the Navigator Liberty configuration data persistent volume claim must be statically provisioned instead of waiting for the persistent volume claim to be dynamically provisioned storage on demand by the operator.

Move

The process to move or upgrade your existing traditional WebSphere Application Server P8 domain to change to an environment that is fully deployed on containers is similar to a new installation on containers, except that you use your existing configuration of supporting software like databases and directory servers. The move or upgrade to the newer version is accomplished by the deployment and startup of the component containers.

About this task

An upgrade deployment means to move to containers and upgrade the level of software currently in use in your traditional WebSphere deployment environment. An upgrade deployment starts from a V5.2.x or V5.5.x installation, and upgrades to V5.5.6 as part of the conversion.

A move deployment means to move to containers without changing the level of software currently in use. A move deployment starts from a traditional V5.5.6 or later installation.

Before you start the move or upgrade, read through the information on preparing your environment, make sure you have performed all of the required preparation steps, and review the steps for a new container deployment. The move process includes a full backup of your source system.

If your source IBM Content Navigator is configured for SSO, choose the SSO container image for Navigator.

To move your installation to containers:

  1. Complete your custom resource file For FileNet Content Manager and for Business Automation Navigator with the values for your environment. 

    Important: Do not include the initialization and verification sections in your custom resource. These capabilities do not apply in a move to the Cloud Pak.

  2. Stop the IBM Content Search Services index dispatcher.
  3. Stop all instances of the IBM Content Search Services servers that are part of this FileNet P8 domain.

    As the root user, navigate to /opt/IBM/ContentSearchServices/CSS_Server/bin, and enter the following command:

    ./shutdown.sh

  4. Stop and back up the Content Platform Engine components and databases.
    After the database backups complete, ensure that the databases are running.
  5. (For upgrade moves) Verify that the props.jar file, extracted from the traditional WebSphere Application Server deployed Engine-ws.ear as described in section "Prepare your source FileNet Content Manager environment for the move," was placed it into the directory that you created for the Content Platform Engine FileNet (for upgrade) bootstrap persistent volume claim you will use for the Content Platform Engine container deployment. To do this before the cpe container is deployed, the bootstrap persistent volume claim must be statically provisioned instead of waiting for the persistent volume claim to be dynamically provisioned storage on demand by the operator.
    • Important: If your FileNet P8 domain is already upgraded to V5.5.1 or later, you can skip this step.
  6. If you are moving IBM Content Navigator, verify that the Navigator primary encryption key, backed-up as described in section "Prepare your source FileNet Content Manager environment for the move," was copied to the persistent volume claim created for the IBM Business Automation Navigator Liberty configuration data. To do this before the Navigator container is deployed, the Navigator Liberty configuration data persistent volume claim must be statically provisioned instead of waiting for the persistent volume claim to be dynamically provisioned storage on demand by the operator.
  7. Use the instructions in Deploying the custom resource to apply your custom resource file by using the operator. Follow the included steps to verify your deployment after the process completes.
  8. If this is an upgrade move, use the following topics to verify your upgrades:
    Completing and verifying the FileNet Content Manager upgrade
    Completing and verifying the Business Automation Navigator upgrade

Completing post deployment tasks

After you run the container deployment, you perform additional tasks to update and start your P8 domain. Verify that your deployment is complete and that your containers are up and running before you do these steps.

Enabling SSL between containers

If SSL is enabled in the existing system for the Content Platform Engine to Content Search Services communications, use your own SSL keystore and certificate files in place of the default files that are provided with the Content Platform Engine container deployment. Add the files keystore.jks and trustore.jks from your existing system to the configuration overrides directory that you created on the Content Platform Engine configuration volume, for example: /cpecfgstore/cpe/configDropins/overrides.

Enable SSL between the text search servers and Content Platform Engine.

In all the following cases, the files holding the certificates are added to the volume that you created for the Content Search Services configuration volume, for example, /contentServices/CSS/css-data.

If the existing system enabled SSL for the Content Platform Engine to Content Search Services communications, you must use your own SSL keystore and certificate files in place of the default file that is provided with the Content Search Services container deployment. Add the fileskeystore.jks and truststore.jks from your existing system to the CSS configuration volume.

If the existing system did not previously enable SSL for the Content Platform Engine to Content Search Services communication, the sample cssSelfsignedServerStore file provided by default with the Content Search Services container can be downloaded and used. Add the downloaded cssSelfsignedServerStore file to the Content Search Services configuration volume.

Alternatively, you can generate and store your own certificates in the Content Search Services configuration volume as described in the topic Configuring SSL for IBM Content Search Services.

Content Platform Engine

To configure Content Platform Engine after a move to containers:

  1. For any standard file store areas you have defined, edit the root path property to reflect the mountPath as viewed from inside the container.
    1. Log in to the Administration Console for Content Platform Engine, and navigate to Domain > Object stores > object_store > Administrative > Storage > Storage Areas.
    2. Choose the File Storage Area.
    3. On the Properties tab, edit the property Root Directory path based on the Content Platform Engine filestore volume mapping to the mountPath /opt/ibm/asa. For example, if a file storage area exists at /data/FMdomain_Marketing/FS1 and the Content Platform Engine filestore volume claim is to /data/FMdomain_Marketing, the new value for the Root Directory Path is opt/ibm/asa/FS1.
    4. Repeat these steps for every file storage area in the FileNet P8 domain.
  2. For any advanced storage device that is defined as a file system storage device, edit the advanced storage device root path.
    1. Log in to the Administration Console for Content Platform Engine, and navigate to Domain > Object stores > object_store > Administrative > Advanced Storage > Advanced Storage Devices.
    2. Choose the Advanced Storage Device.
    3. On the Configuration tab, edit the value for Root Directory path based on the Content Platform Engine filestore volume mapping to the mountPath /opt/ibm/asa. For example, if an advanced storage device exists at /data/FMdomain_Marketing/ASAD1 and the Content Platform Engine filestore volume claim is to /data/FMdomain_Marketing, the new value for the Root Directory Path will be /opt/ibm/asa/ASAD1.
    4. Repeat these steps for every advanced storage device in the FileNet P8 domain.

Content Search Services

To configure Content Search Services after a move to containers:

  1. For each existing index area, edit the index areas root path values to reflect the mountPath for the Content Search Services containers:
    1. Log in to the Administration Console for Content Platform Engine using the credentials of the object store owner. If you use different credentials, you might not have the required permissions for the object store.
    2. In the Administration Console for Content Platform Engine, navigate to Domain > Object stores > object_store > Administrative > Index Areas.
    3. Choose an index area to edit.
    4. On the General tab, edit the property Root Directory based on the Content Search Service index area volume mapping to the mountPath/opt/ibm/indexareas. For example, if an index area IndexArea1 exists at /data/Marketing_Indexes/IndexArea1 and the Content Search Services index store volume claim is to /data/Marketing_Indexes, the new value for the Root Directory is /opt/ibm/indexareas/IndexArea1.
    5. Repeat these steps for every index area in the FileNet P8 domain.
  2. Change the ownership of the existing index areas so that they can be accessed by the Content Search Services services that are deployed as containers.

    Modify the index areas parent directory and all children to have ownership of 65534. Use a command like the following example, where the sample parent directory is /data/Marketing_Indexes:

    chgrp -R 65534 /data/Marketing_Indexes

    If a single parent directory for all index areas does not exist, create the parent directory in the file system and reference from it to the pre-existing data. As an alternative, you can also move the index areas so that they are all located under a single parent directory.

  3. If your container deployment exists alongside an on-premises deployment, modify the file system that holds the index areas to provide a reference for the Content Search Service services that are deployed as Java™ applications. The reference enables the services to see the index area parent directory as /opt/ibm/indexareas.
  4. Modify the existing FileNet P8 domain configuration to incorporate the newly deployed Content Search Service services:
    1. Obtain the configuration details for the new Content Search Services services in the container deployment:
      1. From the command line, use your Content Search Services pod name and run the following command: kubectl exec -it pod pod_name bash
      2. From the command line, change to the /opt/IBM/ContentSearchServices/CSS_Server/bin directory, and run the following command to get the authentication token:

        ./configTool.sh printToken -configPath ../config

        Make a note of the token so you can use it during the configuration.

      3. Exit out of the pod.
      4. From the command line, run the following command to get information about the pod: kubectl describe pod pod_name

        Make a note of the IP and port (8199) so you can use it during the configuration.

    2. Configure a text search server for each IBM Content Search Services deployment by navigating to Global Configuration > Administration > Text Search Servers > New Text Search Server, and complete the wizard:

      Server state: Ensure all Content Search Services servers in the containerized environment are configured for Dual: IndexAndSearch mode.

      Server parameters: Set the Host name and Port values to the pod IP and the cssssl port as seen from the container. Add the authentication token. This encryption key is used to encrypt the password during text index backup and restore operations.

      Communication security: Check Enable use of the Secure Socket Layer (SSL) protocol. Uncheck Validate the SSL server certificate and Validate the SSL certificate host.

      Server association: Set the Affinity Group value to the same affinity group that is set for your existing on-premises CSS server.

    3. Save the server settings.
    4. Repeat the preceding steps for all the newly deployed Content Search Service services.
  5. Expand Index Areas, and update the path to point to the container's index area. To find the path, run the following command:

    kubectl exec -it pod_name bash

    Examine the output and look for the path value for index areas, for example, opt/ibm/indexareas.

  6. Alter any affinity groups that might exist to incorporate the additional text search servers. Navigate to Domain > Global Configuration > Administration > Text Search Servers, and choose a text search server to edit.
    1. Ensure that one or more text search servers created for the containerized Content Search Services deployments are assigned as members in existing affinity groups.
    2. Remove the old text search servers from any affinity groups they might belong to.
    3. Leave the old text search servers disabled and schedule them for future deletion.
  7. Re-enable text indexing for the object stores. For more information, see Starting the IBM Content Search Services index dispatcher.

Business Automation Navigator

After you update your Navigator to a container deployment, use the Navigator administration desktop to update settings for the container environment. To configure IBM Content Navigator after a move to containers:
  1. Add the Daeja® Viewer license files to the configuration overrides directory for Business Automation Navigator. For example, /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides.
  2. Update the Daeja Viewer log file path, if necessary. The default log file in the on-premises system before upgrade is install_dir/ibm/viewerconfig/logs/daeja.log, where install_dir is the directory where Navigator is installed. Update the path to reflect your container deployment location, for example, /opt/ibm/viewerconfig/logs/daeja.log
  3. Update the Sync Services URL:
    1. In the IBM Content Navigator administration desktop, click Sync Services.
    2. Update the default value for the public service URL.

      Note: If you are using container versions of the applications side-by-side with on-premises versions, you have the option to leave your Sync Services URL to the on-premises setting, or to change it to the public service URL.

  4. For any Navigator instance that references a FileNet® P8 repository that is managed by a container deployment of Content Platform Engine, modify the server URL value to incorporate the cpe service, for example, icp4a-cpe-svc:
    1. Log into the Navigator administration desktop.
    2. Open the Repositories view, select the FileNet P8 repository, and choose an action of edit.
    3. Modify the Server URL field to reflect the host and port values from the Administration Console for Content Platform Engine, for example: https://icp4a-cpe-svc/wsi/FNCEWS40MTOM
    4. Repeat this procedure for every FileNet P8 repository in the IBM Content Navigator configuration.
  5. Update custom plug-ins:
    1. Copy the IBM Content Navigator plug-in files from your on-premises location to the /opt/ibm/plugins path in the IBM Content Navigator volume:
      podname=$(oc get pod | grep navigator pod name | awk '{print $1}')
      kubectl cp path to plugin files ${NAMESPACE}/$podname:/opt/ibm/plugins
    2. Open the administration desktop in the web client.
    3. Click Plug-ins, choose the plug-in you want to update, and then click Edit.
    4. Reload the plug-in from the new path in the IBM Content Navigator volume. 
      The plug-in file must be in the /opt/ibm/plugins path in the volume.
    5. Provide any additional configuration updates that the plug-in requires.
    6. Save your changes.
  6. Add the primary encryption key from your old environment to your new environment.

    In the configDropins/overrides volume for Navigator, replace the primary encryption key file with extension .ika with the primary encryption key file from the traditional WebSphere Application Server environment.

Other post-deployment tasks

You perform additional post-deployment tasks depending on what other features you want to enable in your Cloud Pak environment. The following links provide instructions for these post-deployment tasks. Read each topic carefully to ascertain whether the topic applies for your environment.

Post-Deployment Task When To Do This Task
Manually initializing and verifying your content services environment Do not do this task. Your GCD, domain, and object store were created in your previous environment.
Configuring the redirect URL with the identity provider This task applies if you are using an identity provider. 
Determining routes for service access Use this task to discover the routes for accessing your deployed containers.

Optional: Enabling EMC Elastic Cloud Storage

Perform this task if your environment uses EMC Elastic Cloud Storage as a Fixed Content Device.
Optional: Use Content Platform Engine tools (Upgrades only) If you want to use Content Engine Bulk Import tool, Deployment Manager, or the Process Engine developer or administrator tools, use this task to obtain the tools.
Configuring Content Platform Engine for Content Search Services Skip this task because you performed this configuration earlier in these steps.
Configuring external share after deployment Use these tasks (includes sub-tasks) to complete the setup of external share, if that feature was in use in your previous environment or if you want to add the capability.
Configuring the Content Services GraphQL API If you chose to add the GraphQL API to your environment and included the container in your deployment, use these additional configuration tasks to set up the API.
Preparing Task Manager data source connections Do this task if you are using Task Manager in your environment.
Optional: Setting up custom tasks in Task Manager This task applies if you use Task Manager in your environment and want to include custom tasks.
(Optional) Improving security for session cookies Optionally provide additional configuration for security improvement for CPE, CMIS, and GraphQL.
(Optional) Creating load balancer resources for content services containers Learn about load balancer resources, including a sample configuration.
Additional configuring and tuning for Content Search Services You can provide configuration files to help tune your Content Search Services performance.
Troubleshooting IBM FileNet Content Manager initialization This task does not apply.

For Navigator:

Post-Deployment Task When To Do This Task

Configuring Logout SSO between IBM Business Automation Navigator and UMS

You can use this task if you want to add UMS SSO to your environment.
Optional: Configuring Send Mail for Business Automation Navigator Use this task if you used Send Mail in your source environment or you want to include it in your new environment.

Optional: Customizing your Navigator firewall settings

You can use a configuration file to customize firewall security settings.
Troubleshooting Navigator initialization This task does not apply.

What to do next:

(Optional) Modernize

After you have moved to the Cloud Pak, you can start taking advantage of the new capabilities that are included in the Cloud Pak, like the GraphQL API. Modernization includes the process of updating and improving the architecture of your previous environment.

For more information, see Automation capabilities.

Document Location

Worldwide

[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSNVNV","label":"FileNet Content Manager"},"ARM Category":[{"code":"a8m0z0000001fvBAAQ","label":"Container->Kubernetes"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
07 July 2021

UID

ibm16438035