image parameter

Use the image parameter 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 and generating container images, are updated in the image parameter. The Sterling™ Order Management System Operator monitors for changes in the image configuration and upgrades the servers defined in OMEnvironment automatically.

If dataManagement is enabled as explained in dataManagement, the Operator applies the entity changes and fix pack 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
      # agentDefaultDigest: "" 
      # appDefaultDigest: "" 
    # orderHub:
      # base:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-orderhub-base
        # digest: "" 
      # extn:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-orderhub-ext
        # digest: "" 
    # callCenter:
      # base:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-call-center-base
        # digest: "" 
      # extn:
        # tag: ""
        # repository: ""
        # pullPolicy: IfNotPresent
        # imageName: om-call-center-ext
        # digest: "" 
    # orderService:
      # tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
      # imageName: orderservice
      # digest: "" 
    # probe:
      # digest: ""
      # name: ""
      # repository: ""
      # tag: ""

image attributes

The following table explains the attributes applicable for image parameter of OMEnvironment.

Table 1. Properties for `image`
Property	Default value	Value type	Required	Description
`oms`		object	Yes	OMS image configuration. For more information, see oms properties.
`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. For more information, see orderHub properties.
`callCenter`		object	No	Sterling Call Center and `CallCenterExt` image configuration. For more information, see callCenter properties.
`orderService`		object	No	Order Service image configuration. For more information, see orderService properties.
`probe`		object	No	Probe image configuration. For more information, see probe properties.
`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.

oms properties

The following table explains the image parameters applicable for oms group.

Table 2. Properties for `oms`
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.agentDefaultDigest`		string	No	Specify the `agentDefaultDigest` to define a common digest for all agent images. If configured, it overrides the tag. To use a different digest per OMServer instance, specify it at the server level.
`oms.appDefaultDigest`		string	No	Specify the `appDefaultDigest` to define a common digest for all application images. If configured, it overrides the tag. To use a different digest per OMServer instance, specify it at the server level.
`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.

orderHub properties

The following table explains the image parameters applicable for orderHub group.

Table 3. Properties for `orderHub`
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.`
`orderHub.base.digest`		string	No	Specify the digest for `orderHub` extn image.
`orderHub.extn.digest`		string	No	Specify the digest for `orderHub` base image.

`callCenter` properties

The following table explains the image parameters applicable for callCenter group.

Table 4. Properties for `callCenter`
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.`
`callCenter.base.digest`		string	No	Specify the digest for `callCenter` base image.
`callCenter.extn.digest`				Specify the digest for `callCenter` extn image.

orderService properties

The following table explains the image parameters applicable for orderService group.

Table 5. Properties for `orderService`
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.
`orderService.base.digest`		string	No	Specify the digest for `orderService` base image.
`orderService.extn.digest`		string	No	Specify the digest for `orderService` extn image.

probe properties

The following table explains the image parameters applicable for probe group.

Table 6. Properties for `probe`
Property	Default value	Value type	Required	Description
`probe.repository`	`registry.access.redhat.com`	string	No	Specify the repository for the probe image.
`probe.name`	`ubi8/ubi-minimal`	string	No	Specify the name for the probe image.
`probe.tag`	`latest`	string	No	Specify the tag for the probe image.
`probe.digest`		string	No	Specify the `agentDefaultDigest` to define a common digest for all agent images. If configured, it overrides the tag. To use a different digest per OMServer instance, specify it at the server level.