How to Deploy and Configure UX1 Subscription Management
Prerequisites
Before you install UX1 Subscription Management, do the following:
- Make sure that you use CloudBlue Commerce 21.0.
- Make sure that the Order Management application is deployed.
- Contact your Technical Account Manager to find out the latest version of the UX1 Subscription Management component that is compatible with your version of the platform. The following table shows which UX1 Subscription Management versions are compatible with which versions of the platform.
Kubernetes Resource Requirements
Container | CPU cores | RAM in GiB |
---|---|---|
ux1-ui | 0.5 | 1.0 |
Required CloudBlue Commerce Components
The UX1 Subscription Management component must be installed together with other core components:
-
OSS 21.10 or later
-
BSS 21.10 or later
-
UI and Branding 21.10 or later
-
Order Management 1.10 or later
-
PLM 1.10 or later
Deploying UX1 Subscription Management
To deploy UX1 Marketplace:
- Ensure the prerequisites.
- Follow the common CloudBlue Commerce component deployment procedure using the UX1 Subscription Management deployment parameters in the config.yaml.
After that, the installed UX1 Subscription Management application will appear under the System Applications tab at Services > Applications.
How to Upgrade UX1 Subscription Management to the Latest Version
To update UX1 Subscription Management, follow the common CloudBlue Commerce component update procedure using the UX1 Subscription Management deployment parameters in the config.yaml.
This will update the UX1 Subscription Management application to the latest version. You can check the version of the application in the CloudBlue Commerce control panel, under the System Applications tab at Services > Applications.
UX1 Subscription Management Deployment Parameters
When installing or updatingUX1 Subscription Management, use the parameters below in config.yaml.
Component Name
ux1-ui
Common Parameters
Parameter | Default value |
---|---|
oauthkey | 7d69aaf7-35af-49dd-bf89-e679c0cacbf2 |
oauthsecret | 2840de45-378c-436b-ab48-e57b2fa09885 |
esjavaopts | -XX:InitialRAMPercentage=30.0 -XX:MaxRAMPercentage=70.0 |
resources.requests.cpu | 300m |
resources.requests.memory | 512Mi |
resources.limits.cpu | 1 |
resources.limits.memory | 1280Mi |
Specific Parameters
None.
Sample config.yaml
Default config.yaml:
--- components: ux1-ui: {}
--- components: ux1-ui: oauthkey: 7d69aaf7-35af-49dd-bf89-e679c0cacbf2 oauthsecret: 2840de45-378c-436b-ab48-e57b2fa09885 javaheapsize: -XX:InitialRAMPercentage=30.0 -XX:MaxRAMPercentage=70.0 resources: requests: cpu: 300m memory: 512Mi limits: cpu: 1 memory: 1280Mi
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.