GOB-Management

Provides for an API to monitor and manage GOB.

Docker

Requirements

• docker compose >= 1.25
• Docker CE >= 18.09

Run

docker compose build
docker compose up &

The API is exposed at port 8143 (http://localhost:8143/gob_management/graphql/).

Tests

docker compose -f src/.jenkins/test/docker-compose.yml build
docker compose -f src/.jenkins/test/docker-compose.yml run --rm test

Local

Requirements

• Python >= 3.9

Initialisation

Create a virtual environment:

python3 -m venv venv
source venv/bin/activate
pip install -r src/requirements.txt

Or activate the previously created virtual environment:

source venv/bin/activate

Run

Start the service:

cd src
python -m gobmanagement

The API is exposed at port 8143 (http://localhost:8143/gob_management/graphql/).

Tests

Run the tests:

cd src
sh test.sh

Security

Access to GOB Management can be protected by using OAuth2 Proxy.

The configuration variables can be stored in .env. An example configuration can be found in .env.example.

OAuth2 Proxy is bypassed for local development. To activate OAuth2 Proxy for local development please follow the directions specified in docker-compose.yml.

GraphQL

GOB Management API provides a GraphQL endpoint on process logs.

The endpoint is provided under /graphql.

The logs can be queried using the following examples:

{
  logs {
    edges {
      node {
        processId
        timestamp
        msg
      }
    }
  }
}

To filter the logs on a single processId use the following example (replace PROCESSID with an actual value):

{
  logs(processId: "PROCESSID") {
    edges {
      node {
        processId
        timestamp
        msg
      }
    }
  }
}

To filter the logs on a source-entity combination use the following example:

{
  logs(source: "Grondslag" entity: "meetbouten") {
    edges {
      node {
        processId
        timestamp
        msg
      }
    }
  }
}

To get a list of all possible source-entity combinations use:

{
  sourceEntities {
    source
    entity
  }
}