Configuring image parameter

  • Used to define image configuration for deployment of servers.
    Important:

    Ensure that the repository name and tag that you create by using the steps explained in customizing certified containers, are updated in the image parameter.

    The IBM® Sterling Order Management System Software Operator monitors for changes in the image configuration and upgrades the servers defined in OMEnvironment automatically.

    If dataManagement is enabled as explained in configuring dataManagement, the Operator applies the entity changes and FP factory setup automatically.

The following .yaml snippet is a sample schema of image:

  image:
    # repository: ""
    # pullPolicy: IfNotPresent
    # imagePullSecrets:
    # - name: ""
    oms:
      tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
      # agentDefaultName: om-agent
      # appDefaultName: om-app
    # orderHub:
      # base:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-orderhub-base
      # extn:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-orderhub-ext
    # callCenter:
      # base:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-call-center-base
      # extn:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-call-center-ext
    # orderService:
      # tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
      # imageName: orderservice

Configuring image parameter

The following table explains the attributes applicable for image parameter of OMEnvironment.
Property Default value Value type Required Description
oms object Yes OMS image configuration.
imagePullSecrets   array No

References to secrets in the same namespace for pulling the images. It can be referred as name-value pair.

Create an image pull secret named ibm-entitlement-key in the namespace where the OMEnvironment is configured.

If the images are present in any other registry, create image pull secrets for all such registries, as shown in the following example.

 image:
  imagePullSecrets:
  - name: <image-Pull-Secret1> 
  - name: <image-Pull-Secret2>
orderHub   object No Order Hub and OrderHubExt image configuration.
callCenter   object No Sterling Call Center and CallCenterExt image configuration.
orderService   object No Order Service image configuration.
pullPolicy IfNotPresent string No Specify the default image pull policy for if/when to pull container image. Available options are IfNotPresent, Always, and Never.
repository   string No Specify the default repository for container images.

Configuring oms parameter

The following table explains the image parameters applicable for oms group.
Property Default value Value type Required Description
oms.tag   string Yes Specify the tag for app and agent images.
oms.agentDefaultName om-agent string No Specify agent image name for tasks such as datasetup, agentServers, integrationServers, and more.
oms.appDefaultName om-app string No Specify app image name for tasks such as appServer and xapiServer deployments.
oms.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
oms.repository image.repository string No Specify the repository for container images.

Configuring orderHub parameter

The following table explains the image parameters applicable for orderHub group.
Property Default value Value type Required Description
orderHub.base.tag   string Yes Specify the tag for orderHub images.
orderHub.extn.tag string Yes Specify the tag for orderHub extn image.
orderHub.base.imageName om-orderhub-base string No Specify the orderHub base image name.
orderHub.extn.imageName om-orderhub-ext string No Specify the orderHub extn image name.
orderHub.base.repository image.repository string No Specify the repository for orderHub base image.
orderHub.extn.repository image.repository string No Specify the repository for orderHub extn image.
orderHub.base.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
orderHub.extn.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.

Configuring callCenter parameter

The following table explains the image parameters applicable for callCenter group.
Property Default value Value type Required Description
callCenter.base.tag   string Yes Specify the tag for callCenter images.
callCenter.extn.tag   string Yes Specify the tag for callCenter extn image.
callCenter.base.imageName om-call-center-base string No Specify the callCenter base image name.
callCenter.extn.imageName om-call-center-ext string No Specify the callCenter extn image name.
callCenter.base.repository image.repository string No Specify the repository for callCenter base image.
callCenter.extn.repository image.repository string No Specify the repository for callCenter extn image.
callCenter.base.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
callCenter.extn.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.

Configuring orderService parameter

The following table explains the image parameters applicable for orderService group.
Property Default value Value type Required Description
orderService.tag   string Yes Specify the tag for orderService image.
orderService.imageName orderservice string No Specify the orderService image name.
orderService.pullPolicy image.pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
orderService.repository image.repository string No Specify the repository for orderService image.