`image` parameter

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: ""
    imagePullSecrets:
    - name: ibm-entitlement-key
    - name: my-private-registry-key1 
    - name: my-private-registry-key2 
    tag: ""
    # pullPolicy: IfNotPresent
    # omsGateway:
      # tag: ""
      # repository: ""
      # pullPolicy: ""
      # imageName: oms-gateway
    # ivService:
      # tag: ""
      # repository: ""
      # pullPolicy: ""
      # appImageName: sip-iv-appserver
      # backendImageName: sip-iv-backend
      # onboardImageName: sip-iv-onboard
    # promisingService:
      # imageName: sip-promising
      # pullPolicy: ""
      # tag: ""
      # repository: 
    # utilityService:
      # repository: ""
      # pullPolicy: ""
      # catalog:
        # tag: ""
        # imageName: sip-catalog
        # onboardImageName: sip-catalog-onboard
        # pullPolicy: ""
      # rules:
        # tag: ""
        # imageName: sip-rules
        # onboardImageName: sip-rules-onboard
        # pullPolicy: ""
      # carrier:
        # tag: ""
        # onboardImageName: sip-carrier-onboard
        # imageName: sip-carrier
        # pullPolicy: ""
      # audit:
        # tag: ""
        # imageName: sip-iv-audit
        # onboardImageName: sip-iv-audit-onboard
        # pullPolicy: ""
      # search:
        # tag: ""
        # imageName: sip-search
        # onboardImageName: sip-search-onboard 
        # pullPolicy: ""
      # logstash:
        # tag: ""
        # imageName: sip-logstash
        # pullPolicy: ""
    # apiDocsService:
      # tag: ""
      # imageName: sip-api-docs
      # repository: ""
      # pullPolicy: ""
    # sipUtils:
      # tag: ""
      # imageName: sip-utils
      # repository: ""
      # pullPolicy: ""
    # optimizerService:
      # tag: ""
      # repository: ""
      # pullPolicy: ""
      # requestOrganizerImageName: sip-optimizer-request-organizer
      # dataCaptureImageName: sip-optimizer-data-capture
      # configurationImageName: sip-optimizer-configuration
      # kpiProcessorImageName: sip-optimizer-kpi-processor
      # provisioningImageName: sip-optimizer-provision
      # optimizationImageName: sip-optimizer-optimization
      # elasticSearchDataProcessorImageName: sip-optimizer-elastic-search-data-processor
      # errorProcessorImageName: sip-optimizer-error-processor

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

Property	Default value	Value type	Required	Description
`tag`		string	Yes	Specify the tag for the image.
`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 omsGateway parameter.
`ivService`		object	No	Inventory Visibility service image configuration. For more information, see ivService parameter.
`promisingService`		object	No	Promising service image configuration. For more information, see promisingService parameter.
`utilityService`		object	No	Utility services (audit, carrier, catalog, rules, and search) image configuration. For more information, see utilityService parameter.
`optimizerService`		object	No	Optimization service image configuration. For more information, see optimizerService parameter.
`apiDocsService`		object	No	Specify `apiDocsService` to access the API docs. For more information, see 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.

`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.

`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`	`IfNotPresent`	string	No	Specify the image pull policy for if/when to pull container image. Available options are `IfNotPresent, Always and Never.`

`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`	`IfNotPresent`	string	No	Specify the image pull policy for if/when to pull container image. Available options are `IfNotPresent, Always and Never.`

`utilityService` parameter

Property	Default value	Value type	Required	Description
`utilityService.repository`		string	No	Specify the repository for `utilityService` image.
`utilityService.pullPolicy`	`IfNotPresent`	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 <utility_service> parameter

<`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`	`IfNotPresent`	string	No	Specify the image pull policy for if/when to pull container image. Available options are `IfNotPresent, Always and Never.`

`optimizerService` parameter

Property	Default value	Value type	Required	Description
`tag`		string	No	Specify the tag for `optimizerService` images.
`repository`		string	No	Specify the repository for `optimizerService` image.
`pullPolicy`	`IfNotPresent`	string	No	Specify the image pull policy for if/when to pull container image. Available options are `IfNotPresent, Always and Never.`
`requestOrganizerImageName`	`sip-optimizer-request-organizer`	string	No	Specify the image name of the request organizer service.
`dataCaptureImageName`	`sip-optimizer-data-capture`	string	No	Specify the image name of the data capture service.
`configurationImageName`	`sip-optimizer-configuration`	string	No	Specify the image name of the configuration service.
`kpiProcessorImageName`	`sip-optimizer-kpi-processor`	string	No	Specify the image name of the KPI processor service.
`provisioningImageName`	`sip-optimizer-provision`	string	No	Specify the image name of the provision service.
`optimizationImageName`	`sip-optimizer-optimization`	string	No	Specify the image name of the order optimization service.
`elasticSearchDataProcessorImageName`	`sip-optimizer-elastic-search-data-processor`	string	No	Specify the image name of the Elasticsearch data processor service.
`errorProcessorImageName`	`sip-optimizer-error-processor`	string	No	Specify the image name of the error processor. service.

`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.

`sipUtils` parameter

Property	Default value	Value type	Required	Description
`tag`		string	No	Specify the tag for the images.
`imageName`	`sip-utils`	string	No	Specify the image name for Sterling Intelligent Promising Operator utility.
`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 Sterling Intelligent Promising Operator utility image.

image parameter

omsGateway parameter

ivService parameter

promisingService parameter

utilityService parameter

<utility_service> parameter

optimizerService parameter

apiDocsService parameter

sipUtils parameter