mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-03-01 10:30:40 -06:00
60fd953c7e
* add README for ociswrapper * add doc on how to tests env config test suites with ociswrapper * document running tests using ociswrapper * update local docker compose setup for running tests * make ocis able to run with ociswrapper * update wrapper doc * run with ociswrapper by default * ignore md files on codacy * fix README format
oCIS Wrapper
A tool that wraps the oCIS binary and provides a way to re-configure the running oCIS instance.
When run, ociswrapper starts an API server that exposes some endpoints to re-configure the oCIS server.
Usage
-
Build
make build -
Run
./bin/ociswrapper serve --bin=<path-to-ocis-binary>
Access the API server at http://localhost:5000.
Also, see ./bin/ociswrapper help for more information.
API
ociswrapper exposes two endpoints:
-
PUT /configUpdates the configuration of the running oCIS instance. Body of the request should be a JSON object with the following structure:
{ "ENV_KEY1": "value1", "ENV_KEY2": "value2" }Returns:
200 OK- oCIS is successfully reconfigured400 Bad Request- request body is not a valid JSON object500 Internal Server Error- oCIS server is not running
-
DELETE /rollbackRolls back the configuration to the starting point.
Returns:
200 OK- rollback is successful500 Internal Server Error- oCIS server is not running