Configuring dataManagement parameter

Important: This configuration is not required if you choose to do data management manually outside of Sterling Order Management System Software Operator.
Used to configure data management properties for loading or upgrading factory data automatically by the Operator as explained in Annotations for IBM Sterling Order Management System Software fix pack.
  • The dataManagement logic monitors the change in version of the Sterling Order Management System Software product based on the image tag, and automatically spawns Kubernetes jobs to apply the database changes contained within the new image.
  • It also applies entity changes provided within the images.
  • The logs of data management pod are saved to persistent volume, <pv path>/logs/<data-management-pod-name>.log.
  • To capture logs for data management, use additionalMounts to mount a Persistent Volume to the /opt/ssfs/runtime/logs directory, as shown in the following snippet:
    additionalMounts:
        storages:
          - mountPath: /opt/ssfs/runtime/logs
            name: <pvc_name>
            matchLabels:
              mylabelkey: mylabelvalue 
    
The following .yaml snippet is a sample schema of dataManagement:
dataManagement:
  mode: upgrade
  # podLabels: {}
  # profile: balanced
  # property:
  #   customerOverrides: ""
  #   envVars: ""
Note: dataManagement is supported only for single schema installation. For multischema installation, see Customizing certified containers.
The following table explains the attributes applicable for the dataManagement spec of OMEnvironment.
Property Default value Value type Required Description
mode   string Yes Specify create as the mode for preparing a fresh database schema including loading the complete Sterling Order Management System Software factory data.
Note:
  • The mode create is required only when an empty schema is being setup. Ensure to set the mode to upgrade once the schema is prepared through create mode.
  • When you install the Sterling Order Management System Software on a fresh database or schema, the default password for user admin is generated automatically. When you run the data management job with create mode, a script is run by the end to reset the password for SYSTEM_USER (admin). The password is fetched from the consoleAdminPassword of spec.Secret. Ensure that you set the consoleAdminPassword in the secret to the password of the admin user for the database. This ensures that you are aware of the password needed to log into your database for the first time.

    There is no impact upon upgrading and the existing passwords will be used.

Specify upgrade as the mode for loading fix pack factory data based on the annotations as mentioned in Annotations for IBM Sterling Order Management System Software fix pack.

podLabels   object No Specify labels for pod as key-value pair.
Note: These pod labels are also copied to deployments.
profile balanced string No Use the name of the profile from attribute serverProfiles[].name to be used by the server.
property.customerOverrides   string No Use the name of customerOverrides from attribute serverProperties.customerOverrides[].groupName or serverProperties.customerOverrides[].derivatives[].groupName.

These customer overrides will be injected into the data-manager pod during the data setup.

property.envVars   string No Use the name of envVars from attribute serverProperties.envVars[].groupName or serverProperties.envVars[].derivatives[].groupName.

These environment variables will be injected into the data-manager pod during the data setup.

Annotations for IBM® Sterling Order Management System Software fix pack

Ensure to set the installed-fixpack annotation on the OMEnvironment manifest to indicate the fix pack that is currently loaded on to the database. This annotation is used by Operator when dataManagement is in the upgrade mode to load the fix pack factory setup above the installed-fixpack.

dataManagement continues to keep this annotation updated to record the latest fix pack applied through the Operator. When you move to a new image by patching the OMEnvironment manifest with new image tags, the fix pack factory setup is loaded appropriately.
  • For fix pack 32 and below, provide the legacy fix pack number as shown in the following example:
    apps.oms.ibm.com/installed-fixpack: "32"
  • For fix pack 10.0.2206.0 and above, provide the Continuous Delivery fix pack number as shown in the following example:
    apps.oms.ibm.com/installed-fixpack: "2206.0"