Files
app-organization-portal/README.md
cecemel 566ec39d9a Feature/delta producer administrative units (#67)
* Setting up file-service

- pre-requisite to download dumps
- pre-requiiste to download the json-diff files
- security considerations: the content of the files created here, is
- assumed to be public data, hence we allow it to be in the public graph

* Bumping deltanotifier and mu-auth, which need

to be able to work with mu-scop-id's

* Delta-producer have multiple background-jobs with different tasks

Hence the introduction of the jobs-controller.
Note: in a more advanced configuration, you can easily extend the
tasks related to one job.

* A pre-requisite to serve dumps, is DCAT api support

The delta-producers make a periodic dump of what is supposed to be
published. They are published according to the DCAT data-model.

Security-considerations: the DCAT producer by the delta-producer flow,
are considered to be public data, hence added to the public graph.

* Introduction of the delta-producer-dump-file-publisher

Service responsible for creating dumps for the (potentially
many) data delta flows.
Here only for the administrative-units, but this can be extended in
the future, in the config.

* Introduction of delta-producer-background-jobs-initiator

This service is responsible for triggering the background jobs related
to the delta-productoin of the administrative-units.

It trigger currently three jobs:
- INITIAL_SYNC: this is the first job to fill the publication graph.
  In theory, this is only run once per deploy
- HEALING_JOB: This is a periodic job, which checks what information
is published vs. what information should have been
published (according to a configuration). If differences are found,
because delta-messages never arrived, they are compensated here/
- DUMP_JOB: A periodic job to create a dump of the publication
graph. This is especially useful for consumers, who don't have to
replay the whole delta-diffs, but just can start from the latest sync
point.

* Introduction of delta-producer-publication-graph-maintainer

This service is the core of the logic which determines what should be
published.
The configuration is provided here, and can be elaborated refined in
the config.
It also excutes the healing logic.

* Introduction of delta-producer-json-diff-file-publisher

This simple service, listens to the updates performed on the
publication graph, and serialized these to json-files which are
compatible with current consumers

* Missing dispatcher rules for DCAT

* Various small things:

- outline, whitespaces and comments

* Update README.md

* bump delta-producer-publication-graph-maintainer

* Add organizations (KAL) - Work in progress

* added organizations graph maintainer

* removed inverses, added all bestuur types

* refactored kalliope api

Co-authored-by: Boris De Vloed <boris.de.vloed@gmail.com>
2021-12-03 11:20:32 +01:00

49 lines
1.8 KiB
Markdown

# Contact Hub
Backend for the Contact Hub application based on the mu.semte.ch microservices stack.
## How to
### Boot up the system in DEV environment
cd /path/to/mu-project
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
You can shut down using `docker-compose stop` and remove everything using `docker-compose rm`.
### Setting up the delta-producers related services
To make sure the app can share data, producers need to be set up. There is an intial sync, that is potentially very expensive, and must be started manually
#### producers administrative-units
1. make sure the app is up and running, the migrations have run
2. in docker-compose.override.yml, make sure the following configuration is provided:
```
delta-producer-pub-graph-maintainer-administrative-units:
environment:
START_INITIAL_SYNC: 'true'
```
3. `drc up -d delta-producer-pub-graph-maintainer-administrative-units`
4. You can follow the status of the job, ideally through the dashboard, but this hasn't been setup yet. The following query should also give results:
```
PREFIX task: <http://redpencil.data.gift/vocabularies/tasks/>
PREFIX adms: <http://www.w3.org/ns/adms#>
PREFIX dct: <http://purl.org/dc/terms/>
SELECT DISTINCT ?job ?operation ?created ?modified ?status WHERE {
GRAPH ?g {
?job a <http://vocab.deri.ie/cogs#Job>;
task:operation ?operation;
adms:status ?status;
dct:created ?created;
dct:modified ?modified.
}
FILTER( ?operation IN (
<http://redpencil.data.gift/id/jobs/concept/JobOperation/deltas/initialPublicationGraphSyncing/administrative-units>,
<http://redpencil.data.gift/id/jobs/concept/JobOperation/deltas/healingOperation/administrative-units>
)
)
}
```