The PSA Integration Service Deployment Procedure

How to Install the PSA Integration Service

To install the PSA Integration component, complete the following steps:

1. Create PSA ConfigMap:

   1. Create the psa-integration-configmap.yaml file that contains PSA configuration. Refer to the following template:

      psa-integration-configmap.yaml

      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: psa-integration-config
      data:
        application.yml: |
          ux1:
            client:
              documentationUrl: "${documentation-url}"
              configs:
                - brandDomain: "${brand-domain-name}"
                  controlPanelUrl: "${control-panel-url}"
                  analyticsId: "${ga-id}"
      
      ...
                - brandDomain: "${brand-domain-name}"
                  controlPanelUrl: "${control-panel-url}"
                  analyticsId: "${ga-id}"

      where:

      • ${documentation-url}: (optional) the URL to PSA documentation for resellers
      • ${brand-domain-name}: the domain name of brand through which resellers access PSA
      • ${control-panel-url}: URL through which resellers open the CloudBlue Commerce control panel
      • ${ga-id}: the Google Analytics ID used for the brand

      This file must contain the following section for each brand through which resellers access PSA:

      - brandDomain: "${brand-domain-name}"
        controlPanelUrl: "${control-panel-url}"
        analyticsId: "${ga-id}"

      Note:
      1. You can use a Helm release name different from psa-integration. In this case, the psa-integration-config metadata name must be correspondingly adjusted.
      2. analyticsId (Google Analytics Id) for each country is provided by Business Analyst.

      Example of psa-integration-configmap.yaml:

      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: psa-integration-config
      data:
        application.yml: |
          ux1:
            client:
              documentationUrl: "https://docs.cloudblue.com/cbc/20.4/premium/content/PSA-Integration/Introduction.htm"
              configs:
                - brandDomain: "cp.us.na.cloud.im"
                  controlPanelUrl: "https://cp.us.na.cloud.im/"
                  analyticsId: "GTM-XX00YY2"
      
                - brandDomain: "cp.ca.na.cloud.im"
                  controlPanelUrl: "https://cp.ca.na.cloud.im/"
                  analyticsId: "GTM-XX00YY2"

   2. Create ConfigMap with this command:

      # kubectl apply -f psa-integration-configmap.yaml

2. Install PSA Integration using Helm CLI:

   1. Update the Helm repository:

      # helm repo update

   2. Create the psa-integration-params.yaml file with parameters for the psa-integration Helm chart. Refer to the following template:

      psa-integration-params.yaml

      ---
      dockerrepo: odindevops-a8n-docker.jfrog.io/psa-integration
       
      dbencryptionkey: ${base64 encoded PSA database encryption key}
      dshost: ${PSA database server's host name}
      dsport: 5432
      dsdbname: ${PSA database name}
      dslogin: ${PSA database username}
      dspassword: ${base64 encoded password of PSA database user}
       
      oabrandurl: ${URL of the CB Commerce brand used to access APS API}
      oauthkey: ${OAuth key of L0 staff member}
      oauthsecret: ${OAuth secret of L0 staff member}

      Refer to Helm chart parameters for more details on each parameter.

   3. Install the psa-integration Helm chart:

      # helm install a8n/psa-integration [--version 1.4.680] --name psa-integration --wait --timeout 300 -f psa-integration-params.yaml

How to Upgrade the PSA Integration Service to the Latest Version

Upgrade from Version 1.2 and later

1. Update the Helm repository:

   # helm repo update

2. Upgrade the psa-integration Helm chart:

   # helm upgrade psa-integration a8n/psa-integration [--version 1.4.680] --wait --timeout 300

Upgrade from Version 1.1

1. Create rewrite rules for each brand through which resellers access PSA as described in CloudBlue Commerce Brand Requirements.
2. Back up the existing PSA Keycloak client for each brand. Refer to Identity Service Management for instructions.
3. Delete the existing PSA Keycloak client. Refer to Identity Service Management for instructions.
4. Create a new PSA Keycloak client for each brand through which resellers access PSA. Refer to Identity Service Management for instructions.
5. Back up the existing ConfigMap:

   # kubectl get configmaps psa-integration-config -o yaml > psa-integration-config-v1.1.yaml

6. Copy the ConfigMap backup file to psa-integration-configmap.yaml and transform the psa-integration-configmap.yaml file as follows:
   1. Remove the country and keycloak properties.
   2. Remove all properties from metadata except name.
   3. Add the brandDomain property.

   4. In the ux1.client.config property, add the following section for each brand through which resellers access PSA:

      - brandDomain: "${brand-domain-name}"
        controlPanelUrl: "${control-panel-url}"
        analyticsId: "${ga-id}"

      For information on the ConfigMap template, refer to psa-integration-configmap.yaml.

7. Apply the ConfigMap changes with this command:

   # kubectl apply -f psa-integration-configmap.yaml

8. Update the Helm repository:

   # helm repo update

9. Back up the psa-integration Helm chart values:

   # helm get values psa-integration > psa-integration-params-v1.1.yaml

10. Copy the backup file to the psa-integration-params.yaml file, then remove the publichostname and externalingress properties from it.

11. Upgrade the psa-integration Helm chart:

    # helm upgrade psa-integration a8n/psa-integration [--version 1.4.680] -f psa-integration-params.yaml --wait --timeout 300

 

How to Roll Back the PSA Integration Service

To roll back the PSA Integration service installation, run this command:

# helm rollback psa-integration 1

The second argument is the revision number that can be obtained through helm history, for example:

# helm history psa-integration
REVISION        UPDATED                         STATUS          CHART                   DESCRIPTION
1               Tue Oct 29 20:18:28 2019        SUPERSEDED      psa-integration-1.0.66  Install complete
2               Wed Oct 30 14:57:21 2019        DEPLOYED        psa-integration-1.0.68  Upgrade complete