Deploying Vendor-rated Data Manager

Installation Prerequisites

Before installing Vendor-rated Data Manager, ensure that:

  • CloudBlue Commerce 21.0 is installed.

Kubernetes Resource Requirements

The minimum Kubernetes resources required for the microservice deployment, including on-premise Kubernetes cluster deployment, are:

Container CPU cores RAM in GiB
ratingenginepayg 1.0 1.25

Firewall Requirements

The following firewall requirements must be satisfied:

  1. General firewall recommendations

  2. The following ports must be open:

    From To Protocol Port Purpose
    oss-node pod ratingenginepayg TCP 8081 For access to Vendor-rated Data Manager service backend (HTTPS is used for communication)

Installing and Upgrading Vendor-rated Data Manager

After you install Vendor-rated Data Manager, you and your resellers can create service plans for PAYG services.

To install or upgrade Vendor-rated Data Manager use the common CloudBlue Commerce component deployment procedure with the config.yaml parameters described below.

Important: Before upgrading a production installation with configured margins or markups from version 1.2.296 or earlier, to ensure the correct transfer of your existing configuration to the latest version, please perform upgrade prechecks.

Component Name

ratingenginepayg

Common Parameters

Parameter Default value

components.ratingenginepayg.javaheapsize

-Xms512m -Xmx1024m
components.ratingenginepayg.jdbcconnectionparams ?sslmode=require&ApplicationName=ratingenginepayg
components.ratingenginepayg.db_secret bss-db

The default values are set automatically during component deployment.

Specific Parameters

Parameter Default value Description
components.ratingenginepayg.period 1800 The interval at which the periodic task 'PAYG Rating Engine periodic rate task' starts
components.ratingenginepayg.period_type SECONDS
components.ratingenginepayg.cache_size 5000 The maximum number of elements stored in local caches
components.ratingenginepayg.charges_limit 5000 The maximum number of charges in one ChargesPacket (see Charge Import API)
components.ratingenginepayg.charge_dates_validation true

This setting enables or disables the validation of the start and end datetimes of the usage data collection period.

Note: Shifting dates to the future may be necessary for testing purposes.

Values:

  • true: if the start and end date-times of the usage data collection period of a usage record are future date-times, data validation will fail and the usage report will not be processed.

  • false (used for testing purposes): the start and end date-times of the usage data collection period are not validated for usage records, and usage data reports are processed even if the usage data collection period is not in the past.

Sample config.yaml

Default config.yaml:

---
components:
  ratingenginepayg: {}

Full config.yaml:

---
components:
  ratingenginepayg:
    javaheapsize: -Xms512m -Xmx1024m
    db_secret: bss-db
    jdbcconnectionparams: ?sslmode=require&ApplicationName=ratingenginepayg
    period: 1800
    period_type: SECONDS
    cache_size: 5000
    charges_limit: 5000
    charge_dates_validation: true

How to Obtain the Current config.yaml from CloudBlue Commerce

When updating CloudBlue Commerce components, you may need to obtain the current config.yaml.

To obtain the current config.yaml from CloudBlue Commerce, on a machine with kubectl, execute the following request:

kubectl -n NAMESPACE get secret config-yaml-backup -o "jsonpath={.data['config\.yaml']}" | base64 -d

Note: NAMESPACE is the namespace of your CloudBlue Commerce installation.
To find it, execute the following command:
kubectl describe svc oss-proxy | grep namespace

How to View the Deployment Parameters with Default Values for the Component Version You Want to Install (values.yaml)

To view the deployment parameters with default values (values.yaml) for the component version you want to install, run the following command from the machine with kubectl:

helm show values <component_name_for_config.yaml> --version <component_version> --username <username_for_deployment_repository> --password <username_for_deployment_repository> --repo <a_link_to_repository_with_CloudBlue Commerce_components>

For username and password to the deployment repository, please contact your Technical Account Manager.

Related Topics

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.