Upgrading IBM FileNet Content Manager

If you deployed IBM FileNet® Content Manager, you must upgrade the ecm_configuration section in the custom resource YAML file that is used in the previous version.

Before you begin

The custom resource file includes several mandatory configuration parameters. Depending on the version of your custom resource YAML file, you must add these mandatory parameters to the file, or provide specific values for parameters that previously used the default value. For more information about these parameters see Mandatory configuration parameters.

Important: Creating a full backup of databases, volumes, and configuration files can help you roll back your upgrade if needed.

About this task

By default, the operator deploys each container by using the image digests that correspond to the image tags in the following table. If you want to override the image digest with a specific image tag (to apply an interim fix for example), you can specify the image tag in the custom resource (CR).

Table 1. FileNet Content Manager Docker image changes in 21.0.3
Configuration parameter Value
cpe.image.tag ga-558-p8cpe
css.image.tag ga-558-p8css
cmis.image.tag ga-306-cmis-la101
graphql.image.tag ga-558-p8cgql
es.image.tag ga-3011-es
tm.image.tag ga-3011-tm
Remember: Be sure to plan the timing of the upgrade to ensure minimal disruption to your users.

The following steps assume that you have all content services containers in your environment. If you do not use all of the containers, skip over the steps for the containers that do not apply.


  1. If you have not already done so, make a backup of your databases and environment volumes.
  2. Verify that the operator is started and shows a STATUS of "Running".
    oc get pods -w
  3. If your deployment includes External share, be sure to create a backup of the p12file, the zibm_custom-ssl.xml file, the ingress.yaml file, and for Identity Provider configuration, the zoidc.xml file.
    Add a .bak extension or move your backups to another folder so that the files are not affected by the upgrade.
  4. Make a backup of the custom resource YAML file that you used to deploy FileNet Content Manager in 20.0.3 or later.
  5. In the new working copy of your custom resource file, make sure that the spec section includes all of the mandatory new parameters.
    • Update the image tag parameters for the version you are upgrading to.
    • In 21.0.3, updates were made to ensure a consistent hostname for all components. The result is a change to the default route hostname in some components. For example, if in the prior deployment an sc_deployment_hostname_suffix value of xyz.example.com was used, the update would be a change from cpe.xyz.example.com to cpe-xyz.example.com.

      If you want to keep the hostname that you defined in a previous release, add the hostname attribute under the ecm_configurationcontainer section. For example:
           hostname: "cpe.test1.9.x.x.x.nip.io"
  6. Update the initialization parameters.

    These settings assume that you are not adding functionality that requires an object store initialization during upgrade.

    1. Under shared_configuration, add the following parameters and set them to false:
      sc_content_initialization: false
      sc_content_verification: false
    2. Comment out all lines, including the header, in the initialize_configuration and verify_configuration sections.
  7. If your environment includes External share and you use the 2-LDAP method for user management, verify that you created a new secret for your external LDAP user name and password (previously included in another secret) and added it to the YAML.
    In the ext_ldap_configuration section, confirm this parameter:
    lc_bind_secret: ibm-ext-ldap-secret
  8. If your environment includes External share and you use the Identity Provider method for user management, confirm that the identity provider configuration settings are in your working copy of the YAML.
    In the YAML, check the section open_id_connect_providers.

    For more information about the open_id_connect_providers parameters, see Identity provider configuration parameters.

    Confirm the required values for your JVM option parameters. For example, for Google Id, ensure that nav_configuration section contains the following parameter settings:
    jvm_customize_options: "DELIM=;-Dcom.filenet.authentication.<Google Provider Name>.AuthTokenOrder=oidc,oauth,ltpa"
  9. Optional: If you want additional debugging information during the upgrade, add the ecm_configuration.no_log=false parameter.

What to do next

Plan your upgrade for a time when it is convenient to restrict all user access to content services. When a pod stops, the Content Platform Engine deployment gives the pod some time to finish the existing workloads that are already assigned to the pod. During this time, additional work requests for that pod are rejected. If the workload does not finish within the assigned time, the pod terminates. Unfinished work transitions to another pod later.

The result is the completion of more in-flight operations reducing the amount of rework and thereby, a particular pod might take longer to stop.

During the process of upgrading your container images, you must also perform the standard checks and post upgrade configuration tasks to ensure that your content services environment continues to function as it did before the upgrade.

The result is the completion of more in-flight operations reducing the amount of rework and thereby, a particular pod might take longer to stop.

To prepare for the upgrade:
  1. Disable the CBRdispatcher as described in the topic Stopping the IBM Content Search Services index dispatcher.
  2. If you have not already done so, make a backup of your databases and environment volumes. See Backing up the data in your FileNet® P8 domain for more information.
  3. Scale down your deployments before you apply the updated custom resource YAML file. Scale down the operator first, then your other components.
    To scale down a specific deployment (for Content Platform Engine, Business Automation Navigator, and Content Search Services):
    kubectl scale --replicas=0 deployment my_deployment_name -n my_project_name

Continue to configure the other capabilities that are in your CR file, and make sure that you complete the last step Validating the YAML in your custom resource file before you apply the CR to the operator.

Apply the updated custom resource YAML file as described in Applying the upgraded custom resource.

When the deployments are available, verify the upgrade by using the instructions in Completing and verifying the IBM FileNet Content Manager upgrade.