Annotations used in Sterling Order Management System Operator
Use the Operator annotations to enable or disable features such as automatically install ActiveMQ driver, scale deployments, install database driver and more.
Annotations that are used internally by the Sterling Order Management System Operator are
prefixed as internal
. Following table enlists the annotations that are used in
Sterling Order Management System Operator.
Key | Allowed Value | Description |
---|---|---|
apps.oms.ibm.com/activate-iv-integration |
yes | If you set the annotation to yes , the integration between Sterling Order Management System Software and Sterling Intelligent Promising Inventory
Visibility is enabled.Once you enable the integration, you cannot disable it. Therefore, ensure that you enable the integration between Sterling Order Management System Software and Sterling Intelligent Promising Inventory Visibility only if customers want to use Sterling Intelligent Promising Inventory Visibility. |
apps.oms.ibm.com/activemq-install-driver |
yes |
If the annotation is set to yes , the Sterling Order Management System
Operator automatically installs the ActiveMQ driver. |
apps.oms.ibm.com/activemq-driver-url |
string | The Sterling Order Management System Operator automatically installs the ActiveMQ driver
based on the vendor from public URL. Use the annotation to optionally configure an
http URL that contains a download location of relevant ActiveMQ driver from
alternative source such as private servers. The default URL value is
https://repo1.maven.org/maven2/org/apache/activemq/activemq-all/5.16.0/activemq-all-5.16.0.jar . |
apps.oms.ibm.com/auto-managed |
yes | Use this annotation to automatically scale the deployments with the custom resources. The
default value of the annotation is not set to yes . When the annotation is set to
yes , any changes in the specifications of custom resources eventually trigger
changes in its downstream deployments, jobs, and cronjobs.This annotation is applicable to the servers only. Other parameters such as ingresses, services, are updated when the specification changes regardless of the annotation value. In an integrated environment, when this annotation
is added to the If the
Horizontal Pod Autoscaler (HPA) is defined and the annotation
For the job and cronjob OMServers, if there are any changes in the specifications that the job and cronjob need to update, then the existing job or cronjob is removed and a new job is re-created. |
apps.oms.ibm.com/dbvendor-auto-transform |
yes |
If the annotation is set to yes , the Sterling Order Management System
Operator automatically transforms the properties in the pod to connect to the database vendor that
is configured in database
parameter. The database vendor auto transform is used for development purpose only. |
apps.oms.ibm.com/dbvendor-driver-url |
string | The Sterling Order Management System Operator automatically installs the database driver
based on the vendor from public URL. Use the annotation to optionally configure an
http URL that contains a download location of relevant database driver from
alternative source such as private servers. The database vendor driver URL is used for development
purpose only. |
apps.oms.ibm.com/dbvendor-install-driver |
yes |
If the annotation is set to yes , the Sterling Order Management System
Operator automatically installs the database driver for the vendor that is configured in database parameter. The database
vendor install driver is used for development purpose only. |
apps.oms.ibm.com/debug-exec-cmd |
yes |
View (or debug) the command executed to start healthMonitor or
agentServer in the logs. |
apps.oms.ibm.com/enable-kafka-logging |
yes | Configure this annotation to yes for enabling Kafka logging. This annotation
is available for OMServer, Data Management, and Order Service only. Configuring Kafka logging for
the dev instances of Cassandra and Elasticsearch is not supported. For more information, see Configuring Kafka log parameter. |
apps.oms.ibm.com/installed-fixpack |
Indicates the fix pack currently installed on the database. This annotation is used in
dataManagement . For more information, see Annotations for IBM Sterling Order Management System Software fix pack. |
|
apps.oms.ibm.com/refimpl-install |
yes |
Use it to install reference implementation data as part of dataManagement .
The reference implementation is used for development and demo purposes only. |
apps.oms.ibm.com/refimpl-type |
oms or aurora |
Type of reference implementation data that is to be installed. The reference implementation type is used for development and demo purposes only. |
apps.oms.ibm.com/skip-ddls |
yes |
If the annotation is set to yes , the Database Definition Languages (DDLs)
are skipped from being applied when the data manager is running. |
apps.oms.ibm.com/skip-pvc-bound-check |
yes |
Skips Persistent Volume Claim (PVC) bound check and proceeds. It supports Storage Class
dynamic provision with mode WaitForFirstConsumer . |
apps.oms.ibm.com/use-legacy-probe-check |
yes |
Use this annotation to switch back to the old probe check if issues arise. If the annotation
is set to yes , the system uses the old probe check. If the annotation is not set to
yes , which is by default, the system uses the new check, which verifies the status
of the database, message queue, and other relevant components. |