Configuring image parameter

Edit online
Use image to define image configuration for deployment of servers.
Important:

Ensure that the repository name and tag that you create are updated in the image parameter. The IBM® Sterling Intelligent Promising Operator monitors for changes in the image configuration and upgrades the servers defined in SIPEnvironment automatically.

The following YAML snippet is a sample schema of image:
  image:
    repository: ""
    # pullPolicy: IfNotPresent
    imagePullSecrets:
    - name: ""
    # tag:""
    omsGateway:
      # tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
      # imageName: oms-gateway
    ivService:
      # tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
      # appImageName: sip-iv-appserver
      # backendImageName: sip-iv-backend
      # onboardImageName: sip-iv-onboard
    promisingService:
      # imageName: sip-promising
      # pullPolicy: Always
      # tag: ""
      # repository: ""
      # pullPolicy: IfNotPresent
    utilityService:
      # repository: ""
      # pullPolicy: IfNotPresent
      # tag:""
      catalog:
        # tag: ""
        # imageName: sip-catalog
        # onboardImageName: sip-catalog-onboard
        # repository: ""
        # pullPolicy: IfNotPresent
      rules:
        # tag: ""
        # imageName: sip-rules
        # onboardImageName: sip-rules-onboard
        # repository: ""
        # pullPolicy: IfNotPresent
      carrier:
        # tag: ""
        # onboardImageName: sip-carrier-onboard
        # imageName: sip-carrier
        # repository: ""
        # pullPolicy: IfNotPresent
      audit:
        # tag: ""
        # imageName: sip-iv-audit
        # onboardImageName: sip-iv-audit-onboard
        # repository: ""
        # pullPolicy: IfNotPresent
      search:
        # tag: ""
        # imageName: sip-search
        # onboardImageName: sip-search-onboard 
        # repository: ""
        # pullPolicy: IfNotPresent
      logstash:
        # tag: ""
        # imageName: sip-logstash
        # repository: ""
        # pullPolicy: IfNotPresent
    apiDocsService:
      # tag: ""
      # imageName: sip-api-docs
      # repository: ""
      # pullPolicy: IfNotPresent
The following table explains the attributes applicable for image parameter of SIPEnvironment.
Property Default value Value type Required Description
imagePullSecrets   array Yes References to secrets in the same namespace for pulling the images. It can be referred as name-value pair.
omsGateway   object No JWT verifier service image configuration. For more information, see Configuring omsGateway parameter.
ivService   object No Inventory Visibility service image configuration. For more information, see Configuring ivService parameter.
promisingService   object No Promising service image configuration. For more information, see Configuring promisingService parameter.
utilityService   object No Utility services (audit, carrier, catalog, rules, and search) image configuration. For more information, see Configuring utilityService parameter .
apiDocsService   object No Specify apiDocsService to access the API docs. For more information, see Configuring apiDocsService parameter.
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 Yes Specify the default repository for container images.

Configuring omsGateway parameter

Property Default value Value type Required Description
tag   string No Specify the tag for the images.
imageName oms-gateway string No Specify the image name for OMS Gateway.
pullPolicy   string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
repository string No Specify the repository for omsGateway image.

Configuring ivService parameter

Property Default value Value type Required Description
tag   string No Specify the tag for ivService images.
appImageName sip-iv-appserver string No Specify the image name of the app server.
backendImageName sip-iv-backend string No Specify the image name of the backend server.
onboardingImageName sip-iv-onboard string No Specify the image name of the onboarding server.
repository string No Specify the repository for ivService image.
pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.

Configuring promisingService parameter

Property Default value Value type Required Description
tag   string Yes Specify the tag for promisingService images.
ImageName sip-promising string No Specify the image name of the app server.
repository string No Specify the repository for promisingService image.
pullPolicy string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.

Configuring utilityService parameter

Property Default value Value type Required Description
utilityService.repository   string No Specify the repository for utilityService image.
utilityService.pullPolicy   string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
utilityService.<utility_service>   object No Specify the utility services (audit, carrier, catalog, rules, logstash, and search) in the <utility_service>. For example, utilityService.audit.

For more information, see Configuring <utility_service> parameter

Configuring <utility_service> parameter

Property Default value Value type Required Description
<utility_service>.imageName
  • Audit = sip-iv-audit
  • carrier=sip-carrier
  • Catalog= sip-catalog
  • Rules= sip-rules
  • Search= sip-search
  • logstash=sip-logstash
 string No Specify the app server image name of the <utility_service>.
<utility_service>.onboardImageName
  • Audit= sip-iv-audit-onboard
  • Catalog= sip-catalog-onboard
  • Rules= sip-rules-onboard
  • Search= sip-search-onboard
  • Carrier= sip-carrier-onboard
 string No Specify the onboarding server image name of the <utility_service>.
<utility_service>.tag   string No Specify the tag for the <utility_service>.
<utility_service>.repository   string No Specify the repository for utilityService image.
<utility_service>.pullPolicy   string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.

Configuring apiDocsService parameter

Property Default value Value type Required Description
tag   string No Specify the tag for the images.
imageName sip-api-docs string No Specify the image name for API doc service.
pullPolicy   string No Specify the image pull policy for if/when to pull container image. Available options are IfNotPresent, Always and Never.
repository string No Specify the repository for apiDocsService image.