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

Management API endpoint for Nuxeo properties

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2021.40, 2023.1
    • Component/s: Core
    • Release Notes Summary:
      Introducing a new management/configuration endpoint
    • Release Notes Description:
      Hide

      Nuxeo instances can now dump their configuration as json. Sensitive informations are redacted based on key pattern and also on value pattern.

      a simple get is enough:

      curl -u <user>:<password> <nuxeoHost>:8080/nuxeo/api/v1/management/configuration
      
      Show
      Nuxeo instances can now dump their configuration as json. Sensitive informations are redacted based on key pattern and also on value pattern. a simple get is enough: curl -u <user>:<password> <nuxeoHost>:8080/nuxeo/api/v1/management/configuration
    • Tags:
    • Sprint:
      nxplatform #90, nxplatform #91

      Description

      Access to the configuration.properties to check what are the actual values templated and used by Nuxeo can be very tricky:

      • in a scalable environment where nodes can be replaced any time
      • in a container world where getting "in" Nuxeo is nearly impossible or at least not recommended.

      One way to mitigate this issue, having an additional endpoint within the management API to export all nuxeo properties (nxserver/config/configuration.properties).

      The REST response will contain both configured properties (the ones from the configuration.properties file) and the runtime properties (the ones from Framework#getProperties). The format could be:

      {
        "configuredProperties": {
          "NUXEO_HOME": "...",
          ...
        }
        "runtimeProperties": {
          "NUXEO_HOME": "...",
          ...
        }
      }
      

      In order to keep properties safe, we will use the code from MaskSensitiveData class before writing data to the response.

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: