Deploying or Upgrading the PSA Integrations Service

High-Level Architecture

PSA Integrations is an APS application with its own release cycle. One PSA Integrations instance serves all resellers on a CloudBlue Commerce instance.

Installation Prerequisites

Before installing the PSA Integrations component, ensure that:

Kubernetes Resource Requirements

Container CPU cores RAM in GiB
psa-integration 0.5 2.0

(Optional) APS API Access Requirements

Note: This information may be required if you upgrade from version 1.2-1.4.

A precreated L0 staff member with OAuth credentials must exist in the system. This staff member must have the following GET permissions for APS types:

  • http://www.odin.com/billing/order-management
  • http://www.odin.com/billing/Subscription
  • "http://www.parallels.com/products/automation/billing"

This staff member must have this POST permission for an APS type:

  • "http://www.parallels.com/pa/pa-core-services"

To configure permissions:

  1. Go to the Classic Panel. In the top menu, go to Operations.
  2. Proceed to System > Users. Click the necessary staff member.
  3. Switch to the APS Bus Access tab. In the Allowed Operations section, click Add. Add the above permissions.

How to Deploy PSA Integrations

To deploy PSA Integrations:

  1. Ensure the prerequisites above.
  2. Follow the common CloudBlue Commerce component deployment procedure using the PSA Integrations deployment parameters below in the config.yaml.

How to Upgrade PSA Integrations

To update PSA Integrations, follow the common CloudBlue Commerce component update procedure using the PSA Integrations deployment parameters below in the config.yaml.

PSA Integrations 3.x Deployment Parameters

Note: For PSA Integrations 2.x deployment parameters, please go to PSA Integrations 2.x Deployment Parameters.

When installing or updating PSA Integrations 3.x and later, use the deployment parameters below in config.yaml.

Component Name

psa-integration

Common Parameters

Parameter Default value
javaopts -XX:MetaspaceSize=96m -XX:MaxMetaspaceSize=256m -XX:InitialRAMPercentage=30.0 -XX:MaxRAMPercentage=70.0
jdbcconnectionparams ?sslmode=require&ApplicationName=psa-integration
backend.resources.requests.cpu 1000m
backend.resources.requests.memory 768Mi
backend.resources.limits.cpu 4000m
backend.resources.limits.memory 1280Mi
db_secret psa-integration-db
dsport 5432
logfilepath /etc/psa/
log_level.com.odin.rating INFO

Specific Parameters

Parameter Default value Description
dbencryptionkey  

Database encryption key (passed to Helm CLI base64-encoded)

oauthkey   OAuth key of L0 staff member (see (Optional) APS API Access Requirements)
oauthsecret   OAuth secret of L0 staff member (see (Optional) APS API Access Requirements)

Sample config.yaml

Default config.yaml:

---
components:
  psa-integration: {}

Full config.yaml:

---
components:
  psa-integration:
    javaopts: -XX:MetaspaceSize=96m -XX:MaxMetaspaceSize=256m -XX:InitialRAMPercentage=30.0 -XX:MaxRAMPercentage=70.0
    devmode:
      enabled: false
    backend:
      resources:
        requests:
          cpu: 1000m
          memory: 768Mi
        limits:
          cpu: 4000m
          memory: 1280Mi
    dbencryptionkey:
    db_secret: psa-integration-db
    dsport: 5432
    jdbcconnectionparams: ?sslmode=require&ApplicationName=psa-integration
    oauthkey:
    oauthsecret:

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.