Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-17833

Make Elasticsearch audit and UID sequence indexes configurable

    XMLWordPrintable

    Details

    • Tags:
    • Impact type:
      API change, Configuration Change
    • Upgrade notes:
      Hide

      Moved configuration of Elasticsearch indexes for UID sequencer and audit logs to the common-base templates, see:

      • elasticsearch-sequence-index-config.xml.nxftl
      • elasticsearch-audit-index-config.xml.nxftl

      Added related properties to nuxeo.conf:

      • seqgen.elasticsearch.indexName=${elasticsearch.indexName}-uidgen
      • audit.elasticsearch.indexName=${elasticsearch.indexName}-audit

      Removed:

      • ESAuditBackend#IDX_NAME
      • ESAuditBackend#IDX_TYPE
      • ESUIDSequencer#IDX_TYPE

      Added:

      • ElasticSearchConstants#ENTRY_TYPE
      • ElasticSearchConstants#SEQ_ID_TYPE
      • ElasticSearchAdmin#getIndexNamesForType(String type)
      • ElasticSearchAdmin#getIndexNameForType(String type)
      Show
      Moved configuration of Elasticsearch indexes for UID sequencer and audit logs to the common-base templates, see: elasticsearch-sequence-index-config.xml.nxftl elasticsearch-audit-index-config.xml.nxftl Added related properties to nuxeo.conf: seqgen.elasticsearch.indexName=${elasticsearch.indexName}-uidgen audit.elasticsearch.indexName=${elasticsearch.indexName}-audit Removed: ESAuditBackend#IDX_NAME ESAuditBackend#IDX_TYPE ESUIDSequencer#IDX_TYPE Added: ElasticSearchConstants#ENTRY_TYPE ElasticSearchConstants#SEQ_ID_TYPE ElasticSearchAdmin#getIndexNamesForType(String type) ElasticSearchAdmin#getIndexNameForType(String type)
    • Sprint:
      drive-7.10-1
    • Story Points:
      2

      Description

      The Elasticsearch index names used for the UID sequencer and for audit logs are now configurable through the following properties in nuxeo.conf:

      ## Name of the Elasticsearch index for audit logs
audit.elasticsearch.indexName=${elasticsearch.indexName}-audit
## Name of the Elasticsearch index for the uid sequencer
seqgen.elasticsearch.indexName=${elasticsearch.indexName}-uidgen

      As a reminder, the audit Elasticsearch index is mostly used by ESAuditBackend and the UID sequencer index by ESUIDSequencer.

      This allows to have several Nuxeo instances sharing the same Elasticsearch cluster.

      We use the elasticsearch.indexName property (default value : nuxeo) as a prefix to ease configuration of multiple Nuxeo instances sharing an Elasticsearch cluster: changing the single elasticsearch.indexName property is enough to give a unique name to all the Elasticsearch indexes.

      Since the default value for elasticsearch.indexName is nuxeo, the resulting default values for the new properties are:

      audit.elasticsearch.indexName=nuxeo-audit
seqgen.elasticsearch.indexName=nuxeo-uidgen

        Attachments

          Issue Links

          depends on

          Task - A task that needs to be done. NXP-17424 Make Elasticsearch sequence and audit indexes more consistent / configurable

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: