service-config-leader

Service enabling centralized configuration of all Pryv.io components; paired with service-config-follower.

Exposes HTTP REST API to retrieve and update platform configuration. Exposes also HTTP REST API to manage users having access to the platform configuration API.

Installation

Prerequisites: Node.js 16, just

Then:

1. just setup-dev-env
2. just install to install node modules

Running just with no argument displays the available commands (defined in justfile).

Testing

just test [...params]

• Extra parameters at the end are passed on to Mocha (default settings are defined in .mocharc.js)
• Replace test with test-detailed, test-debug, test-cover for common presets

Adding a new template

See the steps to publish a new release on the intranet.

How it works

Takes variables from:

• platform.yml:vars
• config-leader.json:internals

and substitutes them in config-leader.json:dataFolder

You wish to:

Replace a string (recursively or not)

platform.yml or config-leader.json VAR*NAME: 'blablabla' -> *.../${role}.json_ VAR_KEY: "VAR_NAME" (don't forget using quotes)

Replace an object

platform.yml or config-leader.json VAR*NAME: {...} -> *.../${role}.json_ VAR_KEY: VAR_NAME

Platform configuration with the API

Users management

On the startup of the server, a user is created with all possible permissions. Credentials of this user will be displayed in console upon it's creation. Note that this user is recreated each time the server restarts. Therefore it is not an admin user, but rather an initial user, that has sufficient permissions to create other users and should serve as an emergency user after having created first admin-like user.

Contributing

Todo

• release github workflow has been archived in archives it needs to rewritten to publish on dockerHub

License

BSD-3-Clause