common parameter

Use common to define ingress host subdomain by using which ingress or routes are exposed for application servers.

Additionally, use common parameter to define common ingress and service configurations that are applicable to all the appServer instances.

The following YAML file is a sample schema of common:
  common:
    ingress:
      host: ""
      # annotations: {}
      # labels: {}
      # className: ""
      # skipDefaultAnnotations: false
      # ssl:
        # enabled: true
        # identitySecretName: ""
      # customDomains: 
      # - host: ""
      #   annotations: {}
      #   labels: {}
      #   className: ""
      #   skipDefaultAnnotations: false
      #   ssl:
      #     enabled: true
      #     identitySecretName: ""
      # - host: ""
      #   annotations: {}
      #   labels: {}
      #   className: ""
      #   skipDefaultAnnotations: false
      #   ssl:
      #     enabled: true
      #     identitySecretName: ""
    # pod:
      # podAnnotations: {}
      # podLabels: {}
The following table explains the attributes applicable for the common parameter of SIPEnvironment.
Property Default value Value type Required Description
ingress   object Yes Specify the ingress parameter. For more information about configuring ingress, see ingress parameter.
pod.podAnnotations   object No Specify any additional annotations for pod or deployment as a key-value pair.
pod.podLabels   object No Specify any additional labels for pod or deployment as a key-value pair.
Remember: Do not override the following three labels, as they are internally used by the Operator.
  • app
  • type
  • internal.sip.ibm.com/apps

ingress parameter

The following table explains the attributes applicable for the ingress parameter of common.
Property Default value Value type Required Description
host   string Yes Specify the ingress subdomain of the cluster to be used for creating ingress or route resources.
annotations   object No Specify any additional annotations for ingress or routes resource as key value pairs.
className   string No Specify the ingress class name. If there was non-OpenShift Kubernetes cluster, it is defaulted to nginx.
customDomains array No Specify a list of customDomains with one or more Fully Qualified Domain Names (FQDNs) over which your application is exposed. For more information about configuring customDomains, see Configuring customDomains in SIPEnvironment and sample schema.
labels   object No Specify any additional labels for ingress or routes resource as key value pairs.
skipDefaultAnnotations false boolean No Specify this property to true if you want to skip all the annotations that the Operator adds by default.
ssl   object No Specify SSL parameters. For more information, see ssl parameter.

ssl parameter

The following table explains the attributes applicable for the ssl parameter of ingress.
Property Default value Value type Required Description
enabled true boolean No Set this value to true to enable SSL for ingress.
identitySecretName   string No Specify the name of the secret holding TLS certificate to be used as identity for ingress or routes. The ingress or route URL presents the TLS certificate to the clients.