...
<insert rest schema ref here>
Schema
...
Elements and Examples
The REST schema is the entry point for OpenCDS configuration, whether they exist as files on the filesystem or as objects in BerkeleyDB. The main elements are as follows:
...
- C:/opencds-knowledge-repository-data/resources_v1.3
- (Note the forward-slashes for Windows-based systems)
- /home/opencds/knowledge-repository-data/resources_v1.3
BerkeleyDB (BDB
...
)
When OpenCDS is configured using the BDB-based configuration, it will look for configuration in the BDB database in the store folder within the folder specified by the knowledge-repository-path. The opencds.properties file must contain the following lines to enable this configuration strategy:
| Code Block | ||
|---|---|---|
| ||
knowledge-repository.type=STORE knowledge-repository.path=<path_to_store> |
...
If the store folder does not exist, OpenCDS will create it at startup. Please note, however, as this will be a new store, OpenCDS will contain no configuration at all; the Migration tool or the REST Client (see below for each) may be used to upload the configuration metadata to OpenCDS.
...
Configuration API (REST) Version 1.0
REST Client
Migration
A migration path has been provided in order to facilitate migration from configuration file formats from 1.2.x and previous versions.
The migration code supports two methods of migration from version 1.2.x and earlier, namely file-based and REST service-based.
Data must be in previous formats for migration to succeed.
File-based Migration
The file-based method reads from the files in a standard 1.2.x or earlier configuration, transforms the metadata, and writes them in their new format in the specified target location. Recall that prior to 1.3.x, OpenCDS required a specific layout for configuration files in addition to a directory/folder layout for the files. File-based configuration for version 1.3.x also requires a similar layout, but this is handled by the migration program.
<migration example here>
REST Service-based Migration
The REST Service-based migration reads from the files in a standard 1.2.x or earlier configuration, transforms the metadata, and uploads them to the OpenCDS service. The storage locations of these files are handled by OpenCDS; all files must be updated through the REST Configuration Service.
<migration example here>