1. Cloud Native Deployment Guide
  2. Upgrading BRM Cloud Native
  3. Upgrading Your BRM Cloud Native Environment

16 Upgrading Your BRM Cloud Native Environment

Learn how to upgrade your existing Oracle Communications Billing and Revenue Management (BRM) cloud native environment to the latest patch set or interim patch release.

Topics in this document:

In this document, the BRM release running on your production system is called the existing release. The release you are upgrading to is called the new release. For example, if you are upgrading from BRM 12.0 Patch Set 7 to BRM 12.0 Patch Set 8, Patch Set 7 is the existing release and Patch Set 8 is the new release.

Tasks for the BRM Cloud Native Upgrade

This section provides a list of tasks required to upgrade your BRM cloud native deployment to the latest patch set or interim patch release. All patch sets and interim patches are cumulative, so they include the fixes from previous patch sets and interim patches. You can perform a direct upgrade from one patch set to another patch set, or from one patch set to a later patch set with an interim patch. For example, you can perform the following direct upgrades for BRM cloud native:

  • From 12.0 Patch Set 2 to 12.0 Patch Set 3 with Interim Patch 31848465

  • From 12.0 Patch Set 2 to 12.0 Patch Set 4

  • From 12.0 Patch Set 7 to 12.0 Patch Set 8

To upgrade your BRM cloud native deployment, complete these tasks in the specified order:

  1. If you are upgrading from 12.0 Patch Set 2 to 12.0 Patch Set 3 or later, migrate your BRM cloud native Helm charts to the v3.x format by using the helm2to3 utility. The Helm charts in BRM cloud native Patch Set 2 use Helm v2.x, and later patch set releases use Helm v3.x. Helm v3.x doesn't readily understand the releases created by Helm v2.x.

    For more information, see "Migrating Helm v2 to v3" in the Helm documentation. The documentation contains references to the migration plugin and to a blog with a comprehensive walk-through of steps using a sample chart.

  2. Upgrade your BRM cloud native database schema. See "Upgrading Your Database Schema".

  3. Upgrade your BRM cloud native services. See "Upgrading Your BRM Cloud Native Services".

  4. Upgrade your Elastic Charging Engine (ECE) cloud native services. See "Upgrading Your ECE Cloud Native Services".

  5. Upgrade your client application services in any order:

Upgrading Your Database Schema

To upgrade your BRM cloud native database schema to the latest 12.0 patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM database initializer Helm chart from the archive. For example:

    tar xvzf oc-cn-init-db-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number such as 1 for Patch Set 1, 2 for Patch Set 2, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-init-db-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Create an override-init-db.yaml file for oc-cn-init-db-helm-chart.

  4. In the override-init-db.yaml file, do the following:

    • Set the ocbrm.is_upgrade key to true.

    • Set the other keys in Table 6-1 as needed.

      Note:

      The BRM root password, wallet passwords, and database details should be the same as in your existing release.

  5. Validate the chart's content by using the helm lint command.

    • For Helm 3.6.0 and later releases, enter this command from the helmcharts directory: 

      helm lint --strict oc-cn-init-db-helm-chart --values oc-cn-init-db-helm-chart/values.yaml --values override-init-db.yaml

    • For previous Helm releases, enter this command from the helmcharts directory: 

      helm lint --strict oc-cn-init-db-helm-chart

    You'll see this if the command completes successfully:

    1 chart(s) linted, no failures

  6. Upgrade the database schema by entering this command from the helmcharts directory. Ensure that you run the Helm chart with a new release name and namespace. 

    helm install newRelease oc-cn-init-db-helm-chart --namespace newNameSpace --values override-init-db.yaml

    where:

    • newRelease is the release name for your new release. This release name must be different from that of your existing release.

    • newNameSpace is the namespace in which to create BRM Kubernetes objects for the new release. This namespace must be different from that of your existing release.

    Your BRM cloud native database schema is upgraded to the new release.

    To determine if the upgrade was successful, enter the following:

    kubectl -n newNameSpace get pods

    If successful, you will see something similar to this:

    NAME           READY  STATUS     RESTARTS  AGE
upgrade-wc6sx  0/1    Completed  0         22h

Upgrading Your BRM Cloud Native Services

Note:

The steps for upgrading your BRM cloud native services are the same for both existing schemas and new schemas.

When you upgrade your BRM cloud native services, it upgrades all BRM core services in your BRM cloud native environment. Table 16-1 lists the BRM core services that are upgraded along with their associated image file names.

Note:

BRM 12.0 Patch Set 2 interim patches also upgrade the Business Operations Center and Billing Care services. In BRM Patch Set 3 and later releases, follow the instructions in "Upgrading Your Business Operations Center Cloud Native Service (upgrading to Patch Set 3 through Patch Set 8)" or "Upgrading Your Business Operations Center Cloud Native Service (upgrading from Patch Set 8 or Later)" and "Upgrading Your Billing Care and Billing Care REST API Cloud Native Services (upgrading to Patch Set 3 through Patch Set 8)" or "Upgrading Your Billing Care and Billing Care REST API Cloud Native Services (upgrading from Patch Set 8 or Later)" to upgrade those services.

Table 16-1 BRM Core Services

BRM Core Service Image File Name

Advanced Queuing Data Manager

oc-cn-brm-dm-aq-12.0.0.x.0.tar

Batch Controller

oc-cn-brm-batch-controller-12.0.0.x.0.tar

BRM Applications

oc-cn-brm-apps-12.0.0.x.0.tar

BRM Configurator Job

oc-cn-brm-config-jobs-12.0.0.x.0.tar

Connection Manager

oc-cn-brm-cm-12.0.0.x.0.tar

Email Data Manager

oc-cn-brm-dm-email-12.0.0.x.0.tar

Enterprise Application Integration Data Manager

oc-cn-brm-dm-eai-12.0.0.x.0.tar

Enterprise Application Integration Java Server

oc-cn-brm-eai-js-12.0.0.x.0.tar

Fusa Data Manager

oc-cn-brm-dm-fusa-12.0.0.x.0.tar

Fusa Simulator

oc-cn-brm-fusa-simulator-12.0.0.x.0.tar

Invoice Data Manager

oc-cn-brm-dm-invoice-12.0.0.x.0.tar

Invoice Formatter

oc-cn-brm-invoice-formatter-12.0.0.x.0.tar

LDAP Data Manager

oc-cn-brm-dm-ldap-12.0.0.x.0.tar

Provisioning Data Manager

oc-cn-brm-dm-prov-telco-12.0.0.x.0.tar

Rated Event Loader

oc-cn-brm-rel-12.0.0.x.0.tar

Real-Time Pipeline

oc-cn-brm-realtime-pipeline-12.0.0.x.0.tar

Roaming Manager

oc-cn-brm-roam-pipeline-12.0.0.x.0.tar

Synchronization Queue Data Manager

oc-cn-brm-dm-ifw-sync-12.0.0.x.0.tar

Vertex Data Manager

oc-cn-brm-dm-vertex-12.0.0.x.0.tar

Web Services Manager

oc-cn-brm-brm_wsm_wls-12.0.0.x.0.tar

oc-cn-brm-brm_wsm_wl_init-12.0.0.x.0.tar

To upgrade your BRM cloud native services to the latest 12.0 patch set or interim patch release:

  1. If you are upgrading from BRM 12.0 Patch Set 3 to BRM 12.0 Patch Set 4, perform these additional steps:

    1. Copy any changes or customizations you made to the Patch Set 3 Helm charts to the Patch Set 4 Helm Charts.

    2. Capture the configuration of running pods in their respective files:

      kubectl -n BrmNameSpace get deployment cm -o=yaml > /tmp/cm.yaml
kubectl -n BrmNameSpace get deployment batch-controller -o=yaml > /tmp/batch_controller.yaml
kubectl -n BrmNameSpace get deployment dm-oracle -o=yaml > /tmp/dm_oracle.yaml
kubectl -n BrmNameSpace get deployment dm-eai -o=yaml > /tmp/dm_eai.yaml
kubectl -n BrmNameSpace get deployment dm-aq -o=yaml > /tmp/dm_aq.yaml
kubectl -n BrmNameSpace get deployment rel-daemon -o=yaml > /tmp/rel-daemon.yaml
kubectl -n BrmNameSpace get deployment dm-ifw-sync -o=yaml > /tmp/dm-ifw-sync.yaml
kubectl -n BrmNameSpace get deployment realtime-pipe -o=yaml > /tmp/realtime-pipe.yaml

    3. In each YAML file created in Step b, add the following entry in two places: under spec.selector.matchLabels and under spec.template.metadata.labels: 

      run: PodName

      where PodName is the pod name such as cm, batch-controller, or dm-oracle.

    4. Apply your changes by running the following commands:

      kubectl -n BrmNameSpace apply -f /tmp/cm.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/batch_controller.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/dm_oracle.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/dm_eai.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/dm_aq.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/dm-ifw-sync.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/rel-daemon.yaml --force
kubectl -n BrmNameSpace apply -f /tmp/realtime-pipe.yaml --force

      The commands bring down the existing pod and then spawns a new one. Thus, the services will not be available for a few seconds.

      Note:

      If you see this warning after running a command, rerun the same command again to resolve the warning. 

      Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply

    5. Run the helm upgrade command for oc-cn-helm-chart to apply the auto-scaling changes: 

      helm upgrade BrmReleaseName oc-cn-helm-chart --values OverrideValuesFile -n BrmNameSpace

  2. If you are upgrading from Patch Set 2 to Patch Set 3 or later, ensure that you back up all Billing Care and Business Operations Center files to their persistent volumes, because they may get deleted if the volume is not HostPath and is dynamically provisioned.

    BRM 12.0 Patch Set 2 interim patches delete your existing Billing Care and Business Operations Center deployments along with their related Kubernetes objects, such as ConfigMaps, Secrets, and persistent volume claims (PVCs).

  3. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  4. Extract the BRM Helm chart from the archive. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number such as 1 for Patch Set 1, 2 for Patch Set 2, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  5. Load and push the images listed in Table 16-1 into your repository.

    See "Loading BRM Component Images" for more information.

  6. Create an upgrade-brm.yaml file for oc-cn-helm-chart.

  7. In the upgrade-brm.yaml file, do the following:

    • Set the ocbrm.is_upgrade key to true.

    • Set the other keys in Table 7-4 as needed.

  8. Run the helm upgrade command for oc-cn-helm-chart using the same release name and namespace that you used for your existing release: 

    helm upgrade existingBrmReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-brm.yaml -n existingBrmNamespace

    where:

    • existingBrmReleaseName is the release name assigned to your existing oc-cn-helm-chart installation.

    • existingOverrideValues is the file name and path to the override-values.yaml file for your existing BRM installation.

    • existingBrmNamespace is the same namespace as for your existing BRM deployment.

Your BRM core services have been upgraded to the latest patch set or interim patch release.

Upgrading Your ECE Cloud Native Services

To upgrade your ECE cloud native services to the latest 12.0 patch set:

  1. Download the latest patch set from the My Oracle Support website (https://support.oracle.com).

    See "Downloading the BRM Cloud Native Deployment Package" for more information.

  2. Extract the ECE Helm chart from the archive into a separate staging area. For example:

    tar xvzf oc-cn-ece-helm-chart-12.0.0.x.0.tgz StagingArea

    where x is the patch set version number such as 1 for Patch Set 1, 2 for Patch Set 2, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-ece-helm-chart-12.0.0.x.0-12345678.tgz.

  3. In your staging area, create a diff between the new values.yaml file and your existing oc-cn-ece-helm-chart/values.yaml file. For example, if you are upgrading from Patch Set 7 to Patch Set 8, do a diff between the Patch Set 7 and Patch Set 8 versions of the values.yaml file.

  4. Using the diff, make a list of the keys that were added, changed, and removed in the new Patch Set release.

  5. Open your existing patch set's override-values.yaml file for oc-cn-ece-helm-chart. This file contains all of the customizations that you made in previous patch set releases.

  6. Do the following:

    • Add and configure any new keys that you want to use.

    • Delete the keys that were removed.

    • If a key's default value changed, determine whether you want to modify the key's value.

  7. Ensure that you have at least three ecs and ecs1 pod replicas configured in the file:

    • charging.ecs1.replicas: Set this to a value of 3 or greater.

    • charging.ecs.replicas: Set this to a value of 3 or greater.

  8. If your current ECE cloud native deployment does not support cdrstore tablespaces and you are upgrading to a version that requires them, do one of the following:

    • Continue without separate tablespaces for cdrstore. To do so, in your override-values.yaml file, set the cdrstoretablespace and cdrstoreindexspace keys to an empty value: 

      cdrstoretablespace: ""
cdrstoreindexspace: ""

    • Use separate tablespaces for cdrstore. To do so, in override-values.yaml file, set the cdrstoretablespace and cdrstoreindexspace keys to the tablespace names.

      Also, grant quota on the new tablespaces to the ECE schema user. Connect to your database as the system user using SQL*Plus, and enter these commands: 

      SQL> ALTER USER EceSchemaUser quota unlimited on ECECDRTABLESPACE;
SQL> ALTER USER EceSchemaUser quota unlimited on ECECDRINDEXSPACE;

  9. Save and close your override-values.yaml file to your staging area.

  10. Delete all existing ECE template files from your staging area's oc-cn-ece-helm-chart/templates directory.

  11. Copy the new ECE template files to your staging area's oc-cn-ece-helm-chart/templates directory.

  12. Upgrade your ECE cloud native services to the latest patch set by running these commands:

    cd StagingArea/oc-cn-ece-helm-chart/
sh upgradeECE_12.0.0.x.0.sh -o OverrideValuesFile -n BrmNameSpace -r EceReleaseName [-s y]

    where:

    • OverrideValuesFile is the path to a YAML file that overrides the default configurations in the oc-cn-ece-helm-chart/values.yaml file.

    • BrmNameSpace is the namespace in which BRM Kubernetes objects reside for the BRM Helm chart.

    • EceReleaseName is the release name for oc-cn-ece-helm-chart and is used to track this installation instance. It must be different from the one used for the BRM Helm chart.

    • -s y specifies to skip the preupgrade steps for ECE.

Upgrading ECE Cloud Native to the Latest Interim Patch

To upgrade your ECE cloud native services from 12.0 Patch Set 4 to the latest 12.0 Patch Set 4 interim patch:

  1. Delete any existing ECE Kubernetes jobs:

    kubectl -n BrmNameSpace get job
kubectl -n BrmNameSpace delete job JobName

    where BrmNameSpace is the namespace in which BRM Kubernetes objects reside for the BRM Helm chart, and JobName is the name of the Kubernetes job.

  2. Download the latest Patch Set 4 interim patch release from the My Oracle Support website (https://support.oracle.com).

    See "Downloading the BRM Cloud Native Deployment Package" for more information.

  3. Extract the ECE Helm chart from the archive into a separate staging area. For example:

    tar xvzf oc-cn-ece-helm-chart-12.0.0.4.0.xyz.tgz StagingArea

    where xyz is the interim patch number.

  4. In your staging area, create a diff between the Patch Set 4 interim patch values.yaml file and your existing Patch Set 4 oc-cn-ece-helm-chart/values.yaml file.

  5. Using the diff, make a list of the keys that were added, changed, and removed in the Patch Set 4 interim patch release.

  6. Open your Patch Set 4 override-values.yaml file for oc-cn-ece-helm-chart.

  7. Do the following:

    • Add and configure any new keys that you want to use.

    • Delete the keys that were removed.

    • If a key's default value changed, determine whether you want to override the key's value.

  8. Ensure that you have at least three ecs and ecs1 pod replicas configured in the file:

    • charging.ecs1.replicas: Set this to a value of 3 or greater.

    • charging.ecs.replicas: Set this to a value of 3 or greater.

  9. Save and close your override-values.yaml file.

  10. Upgrade your ECE cloud native services to the latest Patch Set 4 interim patch release by running these commands:

    cd StagingArea/oc-cn-ece-helm-chart/
sh upgradeECE_12.0.0.4.0.sh -o OverrideValuesFile -n BrmNameSpace -r EceReleaseName -s y

    where:

    • OverrideValuesFile is the path to a YAML file that overrides the default configurations in the oc-cn-ece-helm-chart/values.yaml file.

    • EceReleaseName is the release name for oc-cn-ece-helm-chart and is used to track this installation instance. It must be different from the one used for the BRM Helm chart.

Upgrading Your PDC Cloud Native Services

Note:

  • When you upgrade your PDC cloud native services, it also upgrades your PDC database.

  • If you choose to reuse an existing PDC schema, you must also choose the same rating engine as the existing PDC installation. That is, if your existing PDC installation uses Elastic Charging Engine (ECE) for usage rating, you cannot switch to the Realtime Rating and Batch Rating Engines. Likewise, if your existing PDC installation uses the Realtime Rating and Batch Rating Engines for usage rating, you cannot switch to ECE. If you attempt to switch rating engines, the PDC upgrade fails and generates an error message.

To upgrade your PDC cloud native services and the PDC database to the latest 12.0 patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart from the archive. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

    where x is the patch set version number such as 1 for Patch Set 1, 2 for Patch Set 2, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Download and push the following PDC images into your repository:

    • oracle/pdcapp:12.0.0.x.0

    • oracle/pdcbrminteg:12.0.0.x.0

    See "Loading BRM Component Images" for more information.

  4. In your override-values.yaml file for oc-cn-helm-chart, set the ocpdc.isEnabled key to false.

  5. Run the helm upgrade command to update your BRM Helm release: 

    helm upgrade BrmReleaseName oc-cn-helm-chart --values OverrideValuesFile -n BrmNameSpace

    where:

    • BrmReleaseName is the release name assigned to your existing oc-cn-helm-chart installation.

    • OverrideValuesFile is the file name and path of your override-values.yaml file.

    • BrmNameSpace is the namespace for your existing BRM deployment.

    Note:

    Ensure that all PDC pods, services, and volume mounts have been deleted.

  6. (For upgrades to Patch Set 8 and later) Create a domain creation job by adding PDC-specific keys to your override-values.yaml file for oc-cn-op-job-helm-chart. See "Adding PDC Keys for oc-cn-op-job-helm-chart".

  7. Copy the key values from your existing values.yaml Helm chart to your new values.yaml Helm chart. For more information about these keys, see "Adding PDC Keys for oc-cn-helm-chart".

  8. Delete all existing PDC YAML files from your local oc-cn-helm-charts/templates directory.

  9. Copy the new PDC YAML files to your local oc-cn-helm-charts/templates directory.

  10. In your override-values.yaml file for oc-cn-helm-chart, set the following keys:

    • ocpdc.isEnabled: Set this to true

    • ocpdc.configEnv.transformation.upgrade: Set this to true

    • ocpdc.configEnv.transformation.isClearBRMSeedData: Set this to false

    • ocpdc.configEnv.rcuPrefix: Set this to a new value. For upgrades to Patch Set 5 and later, this value must match the one set in your override-values.yaml file for oc-cn-op-job-helm-chart (see step 6)

  11. Run the helm upgrade command to update your BRM Helm release: 

    helm upgrade BrmReleaseName oc-cn-helm-chart --values OverrideValuesFile -n BrmNameSpace

Upgrading BRM REST Services Manager

To upgrade your BRM REST Services Manager cloud native services to the latest 12.0 patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart from the archives. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number. For example, 2 for BRM 12.0 Patch Set 2, 3 for BRM 12.0 Patch Set 3, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Load and push the BRM REST Services Manager image into your repository.

  4. Disable the brm-rest-services-manager service in your BRM cloud native environment.

    1. Create an upgrade-brm-rsm.yaml file. This file will be used by oc-cn-helm-chart.

    2. In your upgrade-brm-rsm.yaml file, set the ocrsm.rsm.isEnabled key to false.

    3. Stop the brm-rest-services-manager pod by running the Helm upgrade command for the oc-cn-helm-chart: 

      helm upgrade existingBrmReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-brm-rsm.yaml --namespace existingBrmNamespace

      where:

      • existingBrmReleaseName is the BRM release name for your existing release.

      • existingOverrideValues is the file name and path to the override-values.yaml file for your existing brm-rest-services-manager installation.

      • existingBrmNamespace is the BRM namespace for your existing release.

  5. Wait for the brm-rest-services-manager pod to stop.

  6. In your upgrade-brm-rsm.yaml file, set the these keys:

    • ocrsm.rsm.isEnabled: Set this to true.

    • ocrsm.rsm.deployment.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

  7. Copy the SSL Certificate for BRM REST Services Manager.

    1. Create a directory named rsm_keystore under the newly extracted oc-cn-helm-chart/rsm directory.

    2. Copy the files created in the step "Generating an SSL Certificate for BRM REST Services Manager" to the newly created oc-cn-helm-chart/rsm directory.

    3. Start your brm-rest-services-manager services by running the Helm upgrade command for oc-cn-helm-chart: 

      helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-brm-rsm.yaml --namespace existingBrmNamespace

Upgrading Your Business Operations Center Cloud Native Services

The instructions to use to upgrade your Business Operations Center services are different, depending on the patch set you are upgrading to or from.

Note:

When you upgrade your Business Operations Center cloud native service, you can also upgrade your Business Operations Center database schema.

Upgrading Your Business Operations Center Cloud Native Service (upgrading to Patch Set 3 through Patch Set 8)

Follow the instructions in this section only if you are upgrading to 12.0 Patch Set 3 through 12.0 Patch Set 8 from a patch set prior to Patch Set 8. For information about upgrading in other situations, see "Upgrading Your Business Operations Center Cloud Native Services".

To upgrade your Business Operations Center cloud native service and database schema:

  1. Download and install the desired patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart and Operator Helm charts from their archives. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

tar xvzf oc-cn-op-job-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number such as 3 for Patch Set 3, 4 for Patch Set 4, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Load and push the Business Operations Center image into your repository. See "Loading BRM Component Images" for more information.

  4. Disable all Business Operations Center services in your BRM cloud native environment.

    1. Create an upgrade-boc.yaml file and then set the ocboc.boc.isEnabled key to false.

      The upgrade-boc.yaml file will be used with both oc-cn-helm-chart and oc-cn-op-job-helm-chart.

    2. Stop the WebLogic domain by running the helm upgrade command for oc-cn-helm-chart: 

      helm upgrade existingBrmReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNamespace

      where:

      • existingBrmReleaseName is the BRM release name for your existing release.

      • existingOverrideValues is the override-values.yaml file for your existing Business Operations Center environment.

      • existingBrmNamespace is the BRM namespace for your existing release.

    3. Remove the WebLogic domain by running the helm upgrade command for oc-cn-op-job-helm-chart: 

      helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNameSpace

      where existingOpJobReleaseName is the oc-cn-op-job-helm-chart release name for the existing release.

  5. Clean up the data in your Business Operations Center persistent volumes (PVs).

    1. Clean up the domain home from the PV for Business Operations Center:

      rm -rf Domain_home/domains/domainUID

      where:

      • Domain_home is the location specified in the ocboc.boc.wop.domainVolHostPath key.

      • domainUID is the domain name specified in the ocboc.boc.wop.domainUID key. The default is boc-domain.

      See Table 9-1 for more information.

    2. Clean up the application home from the PV for Business Operations Center:

      rm -rf Application_home/BOC

      where Application_home is the path specified in the ocboc.boc.wop.appVolHostPath key.

  6. Deploy Business Operations Center with the latest changes and upgrade the Business Operations Center database schema.

    1. In your upgrade-boc.yaml file, set these Business Operations Center keys:

      • ocboc.boc.isEnabled: Set this to true.

      • ocboc.boc.deployment.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

    2. Run the helm upgrade command for oc-cn-op-job-helm-chart: 

      helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNameSpace

      Wait for the jobs to complete their tasks.

  7. Start your Business Operations Center services by running the helm upgrade command for oc-cn-helm-chart: 

    helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNamespace
Upgrading Your Business Operations Center Cloud Native Service (upgrading from Patch Set 8 or Later)

Follow the instructions in this section only if you are upgrading from 12.0 Patch Set 8 or later. For information about upgrading in other situations, see "Upgrading Your Business Operations Center Cloud Native Services".

To upgrade your Business Operations Center cloud native service and database schema to the latest patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart and Operator Helm charts from their archives. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

tar xvzf oc-cn-op-job-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number such as 3 for Patch Set 3, 4 for Patch Set 4, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Load and push the Business Operations Center image into your repository. See "Loading BRM Component Images" for more information.

  4. Deploy Business Operations Center with the latest changes and upgrade the Business Operations Center database schema.

    1. In your upgrade-boc.yaml file, set these Business Operations Center keys:

      • ocboc.boc.deployment.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

    2. Run the helm upgrade command for oc-cn-op-job-helm-chart: 

      helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNameSpace

      Wait for the jobs to complete their tasks.

  5. Start your Business Operations Center services by running the helm upgrade command for oc-cn-helm-chart: 

    helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-boc.yaml --namespace existingBrmNamespace

Upgrading Your Pipeline Configuration Center Service

To upgrade your PCC service to the latest patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart from the archive. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

    where x is the patch set version number such as 1 for Patch Set 1, 2 for Patch Set 2, and so on. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Download and push the PCC image (oracle/pcc:12.0.0.x.0) into your repository. See "Loading BRM Component Images" for more information.

  4. Disable the PCC service in your BRM cloud native environment:

    1. Create an upgrade-pcc.yaml file for oc-cn-helm-chart.

    2. In your upgrade-pcc.yaml file, set the ocpcc.pcc.isEnabled key to false.

    3. Stop the running pcc pod by running the helm upgrade command for oc-cn-helm-chart: 

      helm upgrade existingBrmReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-pcc.yaml --namespace existingBrmNamespace

      where:

      • existingBrmReleaseName is the BRM release name for your existing release.
      • existingOverrideValues is the file name and path to the override-values.yaml file for your existing BRM installation.
      • existingBrmNamespace is the BRM namespace for your existing release.

  5. Wait for the pcc pod to stop.

  6. In your upgrade-pcc.yaml file, set the following keys:

    • ocpcc.pcc.isEnabled: Set this to true.

    • ocpcc.pcc.deployment.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

  7. Copy the SSL Certificate for PCC:

    1. Create a keystore_pcc directory under oc-cn-helm-chart/pcc.

    2. Copy the appropriate certificates and KeyStore files to the oc-cn-helm-chart/pcc directory:

      • For upgrades to Patch Set 3, Patch Set 4, or Patch Set 5: Use the JKS certificate files created under "Enabling SSL in Your Pipeline Configuration Center Domain".

      • For upgrades to Patch Set 6 or later: Use the default PKCS12 certificate.

        Note:

        For backwards compatibility, the JKS certificates are still supported. In this case, override the default values with the JKS-specific values.

      During deployment, Helm uses the KeyStore files to create a Secret, which will be mounted as a volume inside the pcc pod.

    3. If your KeyStore files have different file names than what is specified in the values.yaml file, update the keyStoreType, keyStoreIdentityFileName, and keyStoreTrustFileName keys in your override-values.yaml file.

  8. Start your pcc pod by running the helm upgrade command for oc-cn-helm-chart: 

    helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-pcc.yaml --namespace existingBrmNamespace

Upgrading Your Billing Care and Billing Care REST API Cloud Native Services

The instructions to use to upgrade your Billing Care and Billing Care REST API services are different, depending on the patch set you are upgrading to or from.

Upgrading Your Billing Care and Billing Care REST API Cloud Native Services (upgrading to Patch Set 3 through Patch Set 8)

Follow the instructions in this section only if you are upgrading to 12.0 Patch Set 3 through 12.0 Patch Set 8 from a patch set prior to Patch Set 8. For information about upgrading in other situations, see "Upgrading Your Billing Care and Billing Care REST API Cloud Native Services".

To upgrade your Billing Care and Billing Care REST API cloud native services:

  1. Download and install the desired patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart and Operator Helm charts from their archives. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

tar xvzf oc-cn-op-job-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number. For example, 3 for BRM 12.0 Patch Set 3, and 2 for BRM 12.0 Patch Set 2. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Load and push the Billing Care image into your repository. See "Loading BRM Component Images" for more information.

  4. Disable all Billing Care and Billing Care REST API services in your BRM cloud native environment.

    1. Create an upgrade-billing.yaml file.

      This file will be used with both oc-cn-helm-chart and oc-cn-op-job-helm-chart.

    2. In your upgrade-billing.yaml file, set these keys:

      • ocbc.bc.isEnabled: Set this to false.

      • ocbc.bcws.isEnabled: Set this to false.

    3. Stop the WebLogic domain by running the Helm upgrade command for oc-cn-helm-chart: 

      helm upgrade existingBrmReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNamespace

      where:

      • existingBrmReleaseName is the BRM release name for your existing release.

      • existingOverrideValues is the file name and path to the override-values.yaml file for your existing Billing Care installation.

      • existingBrmNamespace is the BRM namespace for your existing release.

    4. Remove the WebLogic domain by running the Helm upgrade command for oc-cn-op-job-helm-chart: 

      helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNameSpace

      where existingOpJobReleaseName is the oc-cn-op-job-helm-chart release name for the existing release.

  5. Clean up the data in your Billing Care and Billing Care REST API persistent volumes (PVs).

    1. Clean up the domain home from the PV for Billing Care and Billing Care REST API:

      rm -rf Domain_home/domains/domainUID

      where:

      • Domain_home is the location specified in the ocbc.bc.wop.domainVolHostPath and ocbc.bcws.wop.domainVolHostPath keys.

      • domainUID is the domain name specified in the ocbc.bc.wop.domainUID and ocbc.bcws.wop.domainUID keys. The defaults are billingcare-domain and bcws-domain.

      See Table 9-3 and Table 9-5.

    2. Clean up the application home from the PV for Billing Care and Billing Care REST API:

      rm -rf Application_home/billingcare

      where Application_home is the path specified in the ocbc.bc.wop.appVolHostPath and ocbc.bcws.wop.appVolHostPath keys.

  6. In your upgrade-billing.yaml file, set these Billing Care and Billing Care REST API keys:

    • ocbc.bc.isEnabled: Set this to true.

    • ocbc.bcws.isEnabled: Set this to true.

    • ocbc.bc.deployment.imageTag (Patch Set 3 through Patch Set 7) or ocbc.bc.deployment.app.imageTag (Patch Set 8 or later): Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

    • ocbc.bcws.deployment.imageTag (Patch Set 3 through Patch Set 7) or ocbc.bcws.deployment.app.imageTag (Patch Set 8 or later): Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches.

  7. Deploy Billing Care and Billing Care REST API with the latest changes by running the Helm upgrade command for oc-cn-op-job-helm-chart: 

    helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNameSpace

    Wait for the jobs to complete their tasks.

  8. Start your Billing Care and Billing Care REST API services by running the Helm upgrade command for oc-cn-helm-chart: 

    helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNamespace
Upgrading Your Billing Care and Billing Care REST API Cloud Native Services (upgrading from Patch Set 8 or Later)

Follow the instructions in this section only if you are upgrading from 12.0 Patch Set 8 or later. For information about upgrading in other situations, see "Upgrading Your Billing Care and Billing Care REST API Cloud Native Services".

To upgrade your Billing Care and Billing Care REST API cloud native services to the latest patch set or interim patch release:

  1. Download and install the latest patch set or interim patch release from the My Oracle Support website (https://support.oracle.com).

  2. Extract the BRM Helm chart and Operator Helm charts from their archives. For example:

    tar xvzf oc-cn-helm-chart-12.0.0.x.0.tgz

tar xvzf oc-cn-op-job-helm-chart-12.0.0.x.0.tgz

    where x is the BRM patch set version number. For example, 3 for BRM 12.0 Patch Set 3, and 2 for BRM 12.0 Patch Set 2. If you are extracting an interim patch, the file name will also have the interim patch number appended to it, such as oc-cn-helm-chart-12.0.0.x.0-12345678.tgz.

  3. Load and push the Billing Care image into your repository. See "Loading BRM Component Images" for more information.

  4. In your upgrade-billing.yaml file, set these Billing Care and Billing Care REST API keys:

    • ocbc.bc.deployment.app.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches. For example, enter 12.0.0.3.0 for Patch Set 3, or 12.0.0.3.0-32617916 for Patch Set 3 Interim Patch 32617916.

    • ocbc.bcws.deployment.app.imageTag: Set this to the new release number in the format 12.0.0.x.0 for patch sets and 12.0.0.x.0-nnnnnnnn for interim patches.

  5. Deploy Billing Care and Billing Care REST API with the latest changes by running the Helm upgrade command for oc-cn-op-job-helm-chart: 

    helm upgrade existingOpJobReleaseName oc-cn-op-job-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNameSpace

    Wait for the jobs to complete their tasks.

  6. Start your Billing Care and Billing Care REST API services by running the Helm upgrade command for oc-cn-helm-chart: 

    helm upgrade existingBRMReleaseName oc-cn-helm-chart --values existingOverrideValues --values upgrade-billing.yaml --namespace existingBrmNamespace

Performing a Zero Downtime Upgrade of BRM Patch Sets

You can perform a zero downtime upgrade of your BRM cloud native services and the BRM database schema from 12.0 Patch Set 7 to 12.0 Patch Set 8.

To perform a zero downtime upgrade:

  1. Download the following packages from the Oracle Support website (https://support.oracle.com):

    • BRM 12.0 Patch Set 7

    • BRM 12.0 Patch Set 8

  2. Deploy the BRM Patch Set 7 database schema by following the instructions in "Deploying BRM with a New Database Schema".

    Afterward, verify that oc-cn-init-db-helm-chart deployed successfully.

  3. Configure and deploy the BRM Patch Set 7 oc-cn-helm-chart Helm chart on your system:

    1. In your override-values.yaml file for the Patch Set 7 version of oc-cn-helm-chart, set the following keys: 

      ocbrm:
   refreshInterval: 10
   terminationGracePeriodSeconds: 120
   pcpReconnectDelayOnSocketError: 10
   pcpConnectRetryDelayOnError: 10

    2. In the Patch Set 7 version of the oc-cn-helm-chart/templates/configmap_pin_conf_cm.yaml file, set the following parameter: 

      - cm pcm_connect_max_retries 10

    3. Deploy the Patch Set 7 version of oc-cn-helm-chart: 

      helm install BrmReleaseName oc-cn-helm-chart --values OverrideValuesFile -n BrmNameSpace

  4. Back up your Patch Set 7 Helm charts.

  5. Copy the Patch Set 8 versions of oc-init-db-helm-chart and oc-cn-helm-charts to your system.

  6. Upgrade your BRM database schema from Patch Set 7 to Patch Set 8 by following the instructions in "Upgrading Your Database Schema".

  7. Configure and deploy the BRM Patch Set 8 oc-cn-helm-chart Helm chart on your system:

    1. In your override-values.yaml file for the Patch Set 8 version of oc-cn-helm-chart, set the following keys: 

      ocbrm:
   refreshInterval: 10
   terminationGracePeriodSeconds: 120
   pcpReconnectDelayOnSocketError: 10
   pcpConnectRetryDelayOnError: 10

    2. In the Patch Set 8 version of the oc-cn-helm-chart/templates/configmap_pin_conf_cm.yaml file, set the following parameter: 

      - cm pcm_connect_max_retries 10

    3. In the Patch Set 8 version of the oc-cn-helm-chart/templates/configmap_pin_conf_dm_oracle.yaml file, set the following parameter: 

      - dm dm_ignore_fld_mismatch_err 1

    4. In your override-values.yaml file for the Patch Set 8 version of oc-cn-helm-chart, set the imageTag keys for all components to 12.0.0.8.0.

    5. Run the helm upgrade command for the Patch Set 8 version of oc-cn-helm-chart: 

      helm install BrmReleaseName oc-cn-helm-chart --values OverrideValuesFile -n BrmNameSpace

      Verify that all pods are up and running with Patch Set 8 images.

Performing a Zero Downtime Upgrade of PDC Patch Sets

You can perform a zero downtime upgrade of your PDC cloud native services and the PDC database schema from 12.0 Patch Set 7 to 12.0 Patch Set 8. You do so by using a two-namespace approach in which you create an instance of PDC cloud native in a standby namespace, redirect PDC traffic to services in the standby namespace, upgrade PDC cloud native to Patch Set 8 in your original namespace, and then redirect PDC traffic back to your original namespace.

To upgrade PDC in zero downtime upgrade mode:

  1. Create a temporary namespace, such as BrmStandbyNameSpace.

  2. Clone your PDC OverrideValuesFile file to StandbyOverrideValuesFile.

  3. In your StandbyOverrideValuesFile file for oc-cn-op-job-helm-chart, set the following keys: 

    ocpdc:
   configEnv:
      rcuPrefix: NewPrefix
      crossRefSchemaUserName: XrefSchema 
      pdcSchemaUserName: PdcSchema

    where:

    • NewPrefix is the new prefix for the PDC domain RCU schema.

    • XrefSchema is the same XREF schema name used for deploying PDC in BrmNameSpace.

    • PdcSchema is the same PDC schema name used for deploying PDC in BrmNameSpace.

  4. In your StandbyOverrideValuesFile file for oc-cn-helm-chart, set the following keys: 

    ocpdc:
   configEnv:
      transformation:
         isClearBRMSeedData: false
         upgrade: true

    These settings will upgrade the PDC and XREF schema and prevent the deployment from cleaning the BRM seed data.

  5. Copy the following templates from your BrmNameSpace Helm chart template directory to the BrmStandbyNameSpace Helm chart template directory:

    • secret_env_brm.yaml

    • configmap_pin_conf_brm_apps_2.yaml

    • configmap_loadifwconfig_reg.yaml

    • configmap_env_common.yaml

    • virtual_time_pvc.yaml

    • configmap_infranet_properties_brm_apps.yaml

    • config_jobs.yaml

    • storage_class_green.yaml

    • realtime_pipeline_common_pvc.yaml

    • configmap_tns_admin.yaml

    • secret_wallet_db.yaml

    • _helpers_getDBdetails.tpl

  6. Configure the PDC deployment files in your standby namespace to connect to the CM in your original namespace:

    1. In the template directory of the BrmStandbyNameSpace Helm chart, open the following files:

      • deployment_pdc_bre.yaml

      • deployment_pdc_rre.yaml

      • deployment_pdc_syncpdc.yaml

    2. In each file, change the value of the CM_SERVICE_HOST entry from cm to cm.BrmNameSpace. For example: 

      - name: CM_SERVICE_HOST
  value: "cm.BrmNameSpace"

      where BrmNameSpace is the name of your original namespace.

    3. Save and close your files.

  7. Deploy the PDC Patch Set 7 Helm charts in your standby namespace:

    helm install OpJobStandbyReleaseName oc-cn-op-job-helm-chart --values StandbyOverrideValuesFile --namespace BrmStandbyNameSpace

helm install BrmStandbyReleaseName oc-cn-helm-chart --values StandbyOverrideValuesFile --namespace BrmStandbyNameSpace

  8. Redirect PDC traffic to services in BrmStandbyNameSpace.

  9. Upgrade your PDC cloud native services to Patch Set 8 in BrmNameSpace while requests are temporarily routed to BrmStandbyNameSpace.

    See "Upgrading Your PDC Cloud Native Services" for more information.

  10. Redirect PDC traffic back to services in BrmNameSpace.