devInstances parameter

Use the devInstances parameter to configure development instances of Sterling™ Order Management System containers by using PostgreSQL and ActiveMQ for test purposes only.

The devInstances parameter does not support multischema and SSL is disabled. If you use devInstances with Order Service, you might need to disable SSL for Cassandra and Elasticsearch by applying the following additional configurations:
  orderService:
    # extra configurations
    configuration:
      additionalConfig:
        ssl_cassandra_disable: 'true'
        ssl_elasticsearch_disable: 'true'
The following .yaml snippet is a sample schema of devInstances:
  devInstances:
    profile: ProfileColossal
    postgresql:
      repository: docker.io
      tag: '<tag>'
      name: postgres
      user: postgres
      password: postgres
      database: postgres
      schema: default_schema
      wipeData: false
      # storage:
      #   name: <omsenvironment-operator-pv-oms-test>
      profile: ProfileColossal
      # timezone: <Timezone>

    activemq:
      repository: docker.io
      tag: 6.1.0
      name: apache/activemq-classic
      # storage:
      #   name: <omsenvironment-operator-pv-oms-test>
      profile: ProfileColossal
      # timezone: <Timezone>

    cassandra:
      repository: docker.io
      tag: latest
      profile: huge
      # storage:
      #   name: <pvc_name>
      keyspace: oserv

    elasticsearch:
      repository: docker.elastic.co
      tag: '8.14.3'
      profile: massive
      storage:
        name: <pvc_name>

    kafka:
      name: apache/kafka
      repository: docker.io
      tag: 3.9.1
      topics:
        - os-fetch_order_topic
        - os-index_order_topic
The following table explains the attributes applicable for the devInstances spec of OMEnvironment.
Table 1. Properties fordevInstances
Property Default value Value type Required Description
repository docker.io string No Specify the repository for the image.
pullPolicy IfNotPresent string No Specify the image pull policy.
imagePullSecrets   array No Specify the image pull secrets.
profile   string No Specify the name of the profile from attribute serverProfiles[].name to be used by the server.
postgresql   object No Specify the properties for PostgreSQL. For more information about the properties, see Properties of PostgreSQL.
activemq   object No Specify the properties for ActiveMQ. For more information about the properties, see Properties of ActiveMQ.
cassandra   object No Configure Cassandra for devInstances. For information about configuring cassandra parameter, see Properties of Cassandra.
elasticsearch   object No Configure Elasticsearch for devInstances. For information about configuring elasticsearch parameter, see Properties of Elasticsearch.
kafka   object No Configure Kafka for devInstances. For information about configuring kafka parameter, see #ConfigCRDProperties__kafka_dev.

Properties of PostgreSQL

Table 2. Properties for PostgreSQL
Property Default value Value type Required Description
postgresql.repository docker.io string No Specify the repository for the image.
postgresql.profile   string No Specify the name of the profile from attribute serverProfiles[].name to be used by the server.
postgresql.tag 14 string No Specify the name of the PostgreSQL image tag.
postgresql.name postgres string No Specify the name of the PostgreSQL image.
postgresql.storage   object No Specify the persistent volume for storage. For more information, see storage parameter.
postgresql.user postgres string No Specify the PostgreSQL user name.
postgresql.password postgres string No Specify the PostgreSQL password.
postgresql.database postgres string No Specify the PostgreSQL database.
postgresql.schema postgres string No Specify the default PostgreSQL user schema.
postgresql.timezone   string No Specify the desired time zone.
postgresql.wipeData false boolean No Specify this property to wipe the database clean and restart with a fresh setup.

Properties of ActiveMQ

Table 3. Properties for ActiveMQ
Property Default value Value type Required Description
activemq.repository docker.io string No Specify the repository for the image.
activemq.profile   string No Specify the name of the profile from attribute serverProfiles[].name to be used by the server.
activemq.tag 6.1.0 string No Specify the name of the ActiveMQ image tag.
activemq.name apache/activemq-classic string No Specify the name of the ActiveMQ image.
activemq.storage   object No Specify the persistent volume for storage. For more information, see storage parameter.
activemq.timezone   string No Specify the desired time zone.

Properties of Cassandra

Table 4. Properties for Cassandra
Property Default value Value type Required Description
cassandra.repository docker.io string No Specify the repository for the image.
cassandra.profile   string No Specify the name of the profile from attribute serverProfiles[].name to be used by the server.
cassandra.tag 5.0 string No Specify the name of the Cassandra image tag.
cassandra.name cassandra string No Specify the name of the Cassandra image.
cassandra.storage   object No Specify the persistent volume for storage. For more information, see storage parameter.
cassandra.keyspace   string No Specify the Cassandra keyspace.

Properties of Elasticsearch

Table 5. Properties for Elasticsearch
Property Default value Value type Required Description
elasticsearch.repository docker.elastic.co string No Specify the repository for the image.
elasticsearch.profile   string No Specify the name of the profile from attribute serverProfiles[].name to be used by the server.
elasticsearch.tag 7.17.9 string No Specify the name of the Elasticsearch image tag.
elasticsearch.name elasticsearch string No Specify the name of the Elasticsearch image.
elasticsearch.storage   object No Specify the persistent volume for storage. For more information, see storage parameter.