5 Parameter Updates for OCNADD Microservices

The following sections describe the procedure to update the container images of consumer adapter and egress gateway services by updating the admin service yaml file.

Note:

There could be a potential data loss during parameter modification. Hence, any such activity must be planned in a maintenance window.

5.1 Updating Consumer Adapter Parameters

Note:

In case of an upgrade, rollback, service restart, or configuration is created with the same name, duplicate messages will be sent by the adapter service to avoid data loss.

The consumer adapter service update can be performed for any of the following:

  1. Enabling Egress Annotation
  2. The Egress Adapter Service image changes
  3. HPA configuration changes
  4. Egress Adapter Service parameters changes

Enabling Egress Annotation

Note:

Skip this procedure if CNLB based OCCNE cluster is used.

Egress annotation is required for traffic from OCNADD to be routed outside the cluster. The user needs to enable the following parameter in the corresponding ocnadd-custom-values.yaml and perform the upgrade procedure with respect to the deployment mode.

ocnaddadmin.ocnadd.admin.env.OCNADD_EGRESS_NETWORK_ENABLE: true

Users can update the below parameters according to the network:

Table 5-1 Egress Annotation Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
OCNADD_EGRESS_NETWORK_NAME_VALUE STRING - oam O Name of the egress network configured in the CNE cluster
OCNADD_CNC_ENABLE STRING - true O Enable oracle.com.cnc network

The consumer adapters are associated with the Mediation group:

  • The parameters are always updated using the Mediation group helm charts with common custom values and Mediation group custom values.

For the parameter details, refer to the section "Admin Service Parameters" of Chapter 3 "Customizing OCNADD" in Oracle Communications Network Analytics Data Director Installation, Upgrade, and Fault Recovery Guide.

Step 1: Update the required parameters in custom values (ocnadd-common-custom-values and ocnadd-mediation-custom-values) used for the respective Mediation group.

Step 2: After updating the parameters based on requirements, run the following command to apply the changes: 

helm upgrade <mediation-release-name> -f ocnadd-common-custom-values.yaml -f <mediation-custom-values> --namespace <ocnadd-med-namespace> <helm_chart> --set global.ocnaddmediation.env.admin.OCNADD_ADAPTER_UPGRADE_ENABLE=true

Where:

  • <release_name>: release name of Mediation group deployment
  • <mediation-custom-values>: the custom values file used to deploy the respective Mediation group
  • <ocnadd-med-namespace>: the namespace of the respective Mediation group
  • <helm_chart>: the helm chart folder of the OCNADD

Example:

helm upgrade ocnadd-med -f ocnadd-common-custom-values.yaml -f ocnadd-mediation-custom-values-med-group.yaml --namespace ocnadd-med ocnadd --set global.ocnaddmediation.env.admin.OCNADD_ADAPTER_UPGRADE_ENABLE=true

Step 3: Use the command below to watch the pod status. All the adapter pods respawn after the upgrade: 

watch kubectl get po -n <ocnadd-med-namespace>

Step 4: To verify the parameters have been successfully updated, use the command below: 

kubectl describe po <adapter-pod-name> -n <ocnadd-med-namespace>

5.2 Updating Correlation Service Parameters

The Correlation service update can be performed for any of the following:

  • Correlation Service image changes
  • Correlation Service parameter changes

The Correlation service can be associated with:

  • The parameter upgrade can be performed using the Mediation group helm charts with common custom values and Mediation group custom values.

For the parameter details, refer to the section "Admin Service Parameters" of Chapter 3 "Customizing OCNADD" in Oracle Communications Network Analytics Data Director Installation, Upgrade, and Fault Recovery Guide.

Step 1: Update the required parameters in custom values (ocnadd-common-custom-values and ocnadd-mediation-custom-values) used for the Mediation group.

Step 2: After updating the parameters based on requirements, run the following command to apply the changes: 

helm upgrade <mediation-release-name> -f ocnadd-common-custom-values.yaml -f <mediation-custom-values> --namespace <ocnadd-med-namespace> <helm_chart> --set global.ocnaddmediation.env.admin.OCNADD_CORR_UPGRADE_ENABLE=true

Where:

  • <release_name>: release name of Mediation group deployment
  • <mediation-custom-values>: the custom values file used to deploy the respective Mediation group
  • <ocnadd-med-namespace>: the namespace of the respective Mediation group
  • <helm_chart>: the helm chart folder of the OCNADD

Example:

helm upgrade ocnadd-med -f ocnadd-common-custom-values.yaml -f ocnadd-mediation-custom-values-med-group.yaml --namespace ocnadd-med ocnadd --set global.ocnaddmediation.env.admin.OCNADD_CORR_UPGRADE_ENABLE=true

Step 3: Use the command below to watch the pod status. All the Correlation Service pods respawn after the upgrade: 

watch kubectl get po -n <ocnadd-med-namespace>

Step 4: To verify the parameters have been successfully updated, use the command below: 

kubectl describe po <correlation-pod-name> -n <ocnadd-med-namespace>

5.3 Updating Management Group Service Parameters

To update any of the Management services parameters, follow any of the procedures below based on deployment mode:

  • The parameters are always updated using the Management group helm charts, common custom values, and Management group custom values file.
  • For the parameter details, refer to the section of the respective services in Chapter 3 "Customizing OCNADD" in Oracle Communications Network Analytics Data Director Installation, Upgrade, and Fault Recovery Guide.

Step 1: Update the required parameters in custom values (ocnadd-common-custom-values and ocnadd-mgmt-custom-values) used for the Management group.

Step 2: After updating the parameters based on requirements, run the following command to apply the changes: 

helm upgrade <release-name> -f ocnadd-common-custom-values.yaml -f <mgmt-custom-values> --namespace <ocnadd-mgmt-namespace> <helm_chart>

Where:

  • <release_name>: release name of the Management group
  • <mgmt-custom-values>: the custom values file used to deploy the Management group
  • <ocnadd-mgmt-namespace>: the namespace of the Management group
  • <helm_chart>: the helm chart folder of the Management group

Example:

helm upgrade ocnadd-mgmt -f ocnadd-common-custom-values.yaml -f ocnadd-mgmt-custom-values-mgmt-group.yaml --namespace ocnadd-mgmt ocnadd

Step 3: Use the command below to watch the pod status of the affected Management group service: 

watch kubectl get po -n <mgmt-group-namespace-name>

Step 4: To verify the parameters have been successfully updated, use the command below: 

kubectl describe po <pod-name> -n <mgmt-group-namespace-name>

5.4 Upgrading Worker Group Service Parameters

Update Mediation Group Service Parameters

  • The parameter upgrade can be performed using the Mediation group helm charts with common custom values and Mediation group custom values.

  • For the parameter details, refer to the section "Admin Service Parameters" of Chapter 3 "Customizing OCNADD" in Oracle Communications Network Analytics Data Director Installation, Upgrade, and Fault Recovery Guide.

Step 1: Update the required parameters in custom values (ocnadd-common-custom-values and ocnadd-mediation-custom-values) used for the Mediation group.

Step 2: After updating the parameters based on requirements, run the following command to apply the changes: 

helm upgrade <mediation-release-name> -f ocnadd-common-custom-values.yaml -f <mediation-custom-values> --namespace <ocnadd-med-namespace> <helm_chart>

Where:

  • <release_name>: release name of Mediation group deployment
  • <mediation-custom-values>: the custom values file used to deploy the respective Mediation group
  • <ocnadd-med-namespace>: the namespace of the respective Mediation group
  • <helm_chart>: the helm chart folder of the OCNADD

Example:

helm upgrade ocnadd-med -f ocnadd-common-custom-values.yaml -f ocnadd-mediation-custom-values-med-group.yaml --namespace ocnadd-med ocnadd

Step 3: Use the command below to watch the pod status: 

watch kubectl get po -n <ocnadd-med-namespace>

Step 4: To verify the parameters have been successfully updated, use the command below: 

kubectl describe po <pod-name> -n <ocnadd-med-namespace>

Update Relay Agent Group Service Parameters

  • The parameter upgrade can be performed using the Relay Agent group helm charts with common custom values and Relay Agent group custom values.
  • For the parameter details, refer to the section "Admin Service Parameters" of Chapter 3 "Customizing OCNADD" in Oracle Communications Network Analytics Data Director Installation, Upgrade, and Fault Recovery Guide.

Step 1: Update the required parameters in custom values (ocnadd-common-custom-values and ocnadd-relayagent-custom-values) used for the Relay Agent group.

Step 2: After updating the parameters based on requirements, run the following command to apply the changes: 

helm upgrade <relayagent-release-name> -f ocnadd-common-custom-values.yaml -f <relayagent-custom-values> --namespace <ocnadd-relayagent-namespace> <helm_chart>

Where:

  • <release_name>: release name of Relay Agent group deployment
  • <relayagent-custom-values>: the custom values file used to deploy the respective Relay Agent group
  • <ocnadd-relayagent-namespace>: the namespace of the respective Relay Agent group
  • <helm_chart>: the helm chart folder of the OCNADD

Example:

helm upgrade ocnadd-relay -f ocnadd-common-custom-values.yaml -f ocnadd-relayagent-custom-values-relayagent-group.yaml --namespace ocnadd-relay ocnadd

Step 3: Use the command below to watch the pod status: 

watch kubectl get po -n <ocnadd-relayagent-namespace>

Step 4: To verify the parameters have been successfully updated, use the command below: 

kubectl describe po <pod-name> -n <ocnadd-relayagent-namespace>