Configuring OrderHub Custom Resource
- If you are deploying Order Hub outside of OMEnvironment, configure the JWT properties in Sterling Order Management System Software. For more information about configuring JWT, see Configuring common parameter.
- The
OrderHubis used for deployment of Order Hub servers. For more information about Order Hub, see Using Order Hub. - Ensure that you configure the agent servers that are required by Order Hub. For more information, see Setting BUCAgentsServer, SBAMetricsServer in IBM Sterling Order Management System Software Operator.
The following table enlists and explains the attributes that are used by Order Hub.
| Property | Default value | Value type | Required | Description |
|---|---|---|---|---|
license |
boolean |
Yes | Accept Sterling Order Management System Software license. For more information, see License property. | |
secret |
string |
Yes | Provide the name of the secret that contains sensitive properties for deployment. For more information, see Creating a secret. | |
image |
object |
Yes | Used to define image configuration for deployment of servers. For more information, see Configuring orderHub parameter for image. | |
orderHub |
object |
Yes | Used to define the Order Hub
base and extn deployment parameters. For more information, see
Configuring orderHub parameter. |
|
adminURL |
string | Yes | Specify the URL where smcfs is deployed. |
|
networking.ingress |
object |
Yes | Used to define common ingress and service properties that can be applicable to all the AppServer instances. For more information, see Configuring ingress parameter. | |
networkPolicy |
object |
No | Used to configure network policies to control the traffic flow of pods. For more information, see Configuring networkPolicy parameter. | |
serverProfiles |
object |
No | Used to define the list of server profile definitions where each profile can define its own request and limit values of CPU and memory, and servers can refer to these profiles by just using the profile name. For more information, see Configuring serverProfiles parameter. | |
additionalMounts |
object |
No | List of additional mounts like ConfigMaps, secrets, and PVC with volume mount configuration to be mounted into each pod. For more information, see Configuring additionalMounts parameter. | |
replicaCount |
1 | integer |
No | Specify the number of server instances to be deployed. |
upgradeStrategy |
string | No | Specify the deployment strategy to be used for upgrading the orderHub
deployments. Available options are RollingUpdate and Recreate. |
|
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. |
Configuring OIDC parameter
The following table explains the attributes for the OIDC parameters.
| Property | Default value | Value type | Required | Description |
|---|---|---|---|---|
oidc.enabled |
false | string | No | Enable or disable OIDC. |
oidc.provider |
string | Yes | Specify the OIDC provider name. | |
oidc.discoveryurl |
string | Yes | Specify the OIDC discovery URL. | |
oidc.class |
string | No | Specify the OIDC class. | |
oidc.uniqueClaim |
sub | string | No | Specify the OIDC unique claim details. |
oidc.secondaryid |
string | No | Specify the secondary ID. | |
oidc.logouturl |
string | Yes | Specify the OIDC logout URL. |
Note: The OIDC configuration for Order Hub must match to the server configuration it binds
to.