Configuring restService parameter

  • Used for spawning a dedicated application server for exposing Rest services with a pre-configured authstyle.
  • This configuration is optional if a dedicated deployment for Rest service is not required.
The following .yaml snippet is a sample schema of restService:
        maxPoolSize: 50
        minPoolSize: 10
      # ingress:
        # annotations: {}
        # contextRoots: [smcfs]        
        # customDomains:
        # - host: ""
          # className: ""
          # annotations: ""
          # labels: ""
          # ssl:
            # enabled: ""
            # identitySecretName: ""
        # labels: {}
      # libertyServerXml: default-server-xml
      # livenessCheckBeginAfterSeconds: 900
      # livenessFailRestartAfterMinutes: 10
      serverName: ""
      # service:
        # annotations: ""
        # labels: ""
      terminationGracePeriodSeconds: ""
        max: ""
        min: ""
      # vendor: websphere
      # vendorFile:
    # authstyle: ""
    # podLabels: {}
    # podAnnotations: {}
    # profile: ""
    # property:
      # customerOverrides: ""
      # envVars: ""
      # jvmArgs: ""
    replicaCount: 1
    # affinityAndTolerations: ""
    # image:
    #   name: ""
    #   tag: ""
    # upgradeStrategy: ""
    # userid: ""
    # oidc:
      # enabled: false
      # provider: " "
      # discoveryurl: " "
      # class: " "
      # uniqueClaim: sub
      # secondaryid: email
      # logouturl: " "
    # horizontalPodAutoscaler: HPA1
The following table explains the attributes applicable for the restService parameter of OMEnvironment.
Property Default value Value type Required Description
replicaCount   integer Yes Specify the number of replicas of Rest service to be deployed.
affinityAndTolerations   string No Use the name of the affinityAndTolerations from attribute affinityAndTolerations[].name to be used by the server.   string No Name of the image if different than the relevant OMEnvironment:spec.image.oms.(app/agent)DefaultName.
image.tag   string No Specify the tag of the image. It takes precedence over OMEnvironment:spec.image.oms.tag.
property.customerOverrides   string No Use the name of customerOverrides from attribute serverProperties.customerOverrides[].groupName or serverProperties.customerOverrides[].derivatives[].groupName.
property.envVars   string No Use the name of envVars from attribute serverProperties.envVars[].groupName or serverProperties.envVars[].derivatives[].groupName.
property.jvmArgs   string No Use the name of jvmArgs from attribute serverProperties.jvmArgs[].groupName or serverProperties.jvmArgs[].derivatives[].groupName.
profile balanced string No Use the name of the profile from attribute serverProfiles[].name to be used by the server.
podAnnotations   object No Specify annotations for pod as key-value pair.
podLabels   object No Specify labels for pod as key-value pair.
Note: These pod labels are also copied to deployments.
Note: If the key in the podLabels or podAnnotations is the same as defined in common.pod.podLabels/podAnnotations, then it overwrites the key defined in common.
horizontalPodAutoscaler   string No Specify the name of the pre-defined Horizontal Pod Autoscaler that is to be used. For more information, see Configuring horizontalPodAutoscalers parameter.
authstyle   string No Xapirest property to set the authentication process. Available options are STANDARD, BASIC, and EXTENDED.
userid   string No Xapirest property to define user ID which will be used as the caller of the APIs.
appServer   object No Specify the app server configurations as explained Configuring Application server.
upgradeStrategy   string No Specify the deployment strategy to be used for upgrading the restService deployments. Available options are RollingUpdate and Recreate.
appServer.oidc.enabled false string No Enable or disable OIDC.
appServer.oidc.provider   string Yes Specify the OIDC provider name.
appServer.oidc.discoveryurl   string Yes Specify the OIDC discovery URL.
appServer.oidc.class   string No Specify the OIDC class.
appServer.oidc.uniqueClaim sub string No Specify the OIDC unique claim details.
appServer.oidc.secondaryid email string No Specify the secondary ID.
appServer.oidc.logouturl   string Yes Specify the OIDC logout URL.