Overview

This document describes the OpenCDS Configuration for version 2.x and above.

What's new?

• • Dedicated schemas for describing configuration metadata.
    • Migration tool to migrate configuration schema from the previous version (1.2.x, 1.1.x, etc.) to the new version.
  • REST interface for adding/updating and retrieving the configuration metadata
    • including reloadability of File-based configuration.
  • Backwards compatibility with ClassPath- and File-based configuration.
    • NOT compatible with previous schemas; migration is required.
  • New backend configuration scheme using BerkeleyDB (BDB-JE).
    • This is the only method that is supported via REST.

Run-time OS

For initial OpenCDS run-time configuration, please see start with the relevant section of the documentation according to the operating system where OpenCDS will be deployed, as there are some differences for Windows and Linux/Mac installations:

...

The remaining configuration is the same for all operating systems, and full details follow described below:

Schemas

Configuration Schemas

Backend Configuration of OpenCDS Server

Configuration Backend Tooling

REST Service

PLEASE NOTE: OpenCDS Configuration REST Services should be used while no (DSS) requests are being processed by the system.  Doing otherwise may result in a race condition on the configuration backend, yielding potentially unexpected results.

Security

REST Security

Methods

Configuration API (REST) Version 1.0

Front-end Tooling to Re-configure OpenCDS Server

Use of OpenCDS will normally require posting updates to:

...

These configuration changes can be posted to one or more OpenCDS Servers using the Front-end Tooling, which is currently implemented by a REST client.

REST Client

Configuration Front-end Tooling (REST Client)

Migration from Earlier Versions of OpenCDS Configuration

Configuration Migration