Configuring serverProperties parameter

  • Used to define server property definitions, which includes customer overrides (customerOverrides), environment variables (envVars), and JVM arguments (jvmArgs).
  • Each property can define its property list and associate it with a group name. Servers can refer these properties by using the group name. Each property can define child or derived properties, which can inherit and override its parent properties. The time zone environment variable (TZ) is now supported for all the Sterling Order Management System Software images (app, agent, and base).
  • Alternatively, you can pass your customer overrides as configMaps instead of using the server properties, by using additionalMounts, as explained in Passing customer overrides through configMaps by using additionalMounts.
The following .yaml snippet is a schema of serverProperties:
  serverProperties:
    customerOverrides:
    - groupName: ""
      propertyList: {}
      propertyRef:
      - name: ""
        valueFrom:
          configMapKeyRef:
            key: ""
            name: ""
            optional: 
          fieldRef:
            apiVersion: ""
            fieldPath: ""
          resourceFieldRef:
            containerName: ""
            divisor: "1"
            resource: ""
          secretKeyRef:
            key: ""
            name: ""
            optional: 
      derivatives: []
    envVars:
    - groupName: ""
      propertyList: {}
      propertyRef:
      - name: ""
        valueFrom:
          configMapKeyRef:
            key: ""
            name: ""
            optional: 
          fieldRef:
            apiVersion: ""
            fieldPath: ""
          resourceFieldRef:
            containerName: ""
            divisor: "1"
            resource: ""
          secretKeyRef:
            key: ""
            name: ""
            optional: 
      derivatives: []
    jvmArgs:
    - groupName: ""
      propertyList: {}
      propertyRef:
      - name: ""
        valueFrom:
          configMapKeyRef:
            key: ""
            name: ""
            optional: 
          fieldRef:
            apiVersion: ""
            fieldPath: ""
          resourceFieldRef:
            containerName: ""
            divisor: "1"
            resource: ""
          secretKeyRef:
            key: ""
            name: ""
            optional: 
      derivatives: []
The following table explains the attributes applicable for customerOverrides, envVars, and jvmArgs properties of serverProperties parameter:
Property Default value Value type Required Description
groupName   string Yes Specify the name of the property group. The following group names can be used to specify the customer overrides, environment variables, and JVM arguments for OMServers:
  • serverProperties.customerOverrides[x].groupName
  • serverProperties.envVars[x].groupName
  • serverProperties.jvmArgs[x].groupName
propertyList   array Yes
  • For customerOverrides and envVars, specify properties as key-value pair.
  • For jvmArgs specify properties as an array list.
propertyRef   object No Provide a list of property names with their corresponding source as either a configMap or a secret.
derivatives   array No Specify list of derived properties. It includes groupName, propertyList, and additional list of derived properties if any.

Configuring propertyRef parameter

The following table explains the attributes applicable for the propertyRef parameter. propertyRef is an array containing one or more occurrences of name and valueFrom fields. The valueFrom field supports configMapKeyRef, secretKeyRef, fieldRef, and resourceFieldRef.

Property Default value Value type Required Description
propertyRef.name   string Yes Specify the name of the property to be exposed as customerOverrides or envVars.
Note: jvmArgs does not use the value of this property. However, if you are providing propertyRef for jvmArgs, the name is expected to be unique within the list.
propertyRef.valueFrom   object Yes

The valueFrom supports the following sources: