redis/docs

Feedback: CRDB database config object is missing "module_list" field

Closed this issue · 2 comments

markotrapani commented

Page https://redis.io/docs/latest/operate/rs/references/rest-api/objects/crdb/database_config

The CRDB database config object spec used for default_db_config in CRDB object does not define the module_list field, which is used to ensure desired modules are added to all participating clusters of a CRDB.

For example:

  "module_list": [
    {
      "module_args": "",
      "module_id": "083fd436b861a29913fec6800750bff5",
      "module_name": "ReJSON",
      "semantic_version": "2.8.8"
    },
    {
      "module_args": "PARTITIONS AUTO",
      "module_id": "19572af1170da5915c7aec3d98dd1d2f",
      "module_name": "search",
      "semantic_version": "2.10.13"
    }
  ]

Please consider adding this field to the spec for this object, because, as far as I can tell, it is a requirement to create CRDBs with modules via API.

I should also mention, there is also a module field outside of default_db_config in the CRDB object docs, but no one in US Support has seen this field used, and I was unable to get it to work. I don't understand why it would be necessary to specify a featureset_version for a given module.

rrelledge commented

@markotrapani Thank you for letting us know. I'll open a ticket to fix the reference doc and also investigate the existing module field outside of default_db_config.

markotrapani commented

@rrelledge Thank you! Additionally, tribal knowledge and my own testing suggests that these single subfields are minimally valid options for the API request (because other values have predictable defaults in these cases):

module_name
-- If semantic_version is not specified along with this, it will default to the highest available version installed on the cluster

module_id
-- This identifies both the module name and version simultaneously, rendering both other fields optional

Note: the module_args field is always optional, as each module has default arguments