Skip to content

FAQ

List of frequently asked questions. If your question is not listed or the instructions are unclear / do not solve your problem, please feel free to contact us.

How to get started

The best starting point to get started with the microservices is the release repository. More info can be found in the release instructions. There are also tutorials available for some of the microservices in the tutorials section.

How to contact the developers

The best way to contact the developers is via mattermost. There are dedicated channels for some of the microservices in the itksw group. There are also more general user and developer channels for topics not covered by the above mentioned channels in the ITkPixel group.

Direct links to the mattermost channels: - DeMi Users - DeMi Developers - Analysis Manager - ConfigDB - DAQ API - FELIX - OptoBoard

In addition to these channels there is the atlas-itk-demo-sw-devel e-group. The e-group is used to announce our weekly meetings (currently Tuesday at 17:00). These meetings are focused on development but user feedback is always welcome.

Microservices are not showing up in dashboard

To have the microservices listed in the dashboard the itk-demo-registry microservice needs to be running. In the release it is part of the services stack. Please refer to the release readme for more instructions on how to start it.

If the containers are properly running but not showing up in the dashboard please check the following:

  • try accessing the registry directly to verify that the containers are listed there: http://${HOST}:5111
  • if so, the most likely issue is that the dashboard cannot access the registry. This is most likely caused by a faulty HOST variable configuration. Please see the next question for more details.
Broken links in dashboard / wrong HOST variable

Broken or non-existent links in the dashboard are most commonly caused by a wrongly configured ${HOST} variable. By default the release sets the HOST to the output of the hostname command. Depending on your local configuration this might not be the correct fully qualified domain name that is reachable from other hosts.

You can manually override the HOST variable in the config-script to your local hostname or IP address. If you only want to access the services from the local host (e.g. for development) you can also set it to localhost.

To do so either set the HOST environment variable (or directly edit the config script) and re-run the config script:

export HOST=your.hostname.or.ip
./config
ERROR: 401 Authorization Required when pulling from CERN registry

Authentication is now required when pulling images from the CERN gitlab registry or harbor cache. Follow this guide for instructions. NOTE: use your CERN username, but CLI secret as password (as described in guide).

ERROR: Network deminet declared as external, but could not be found

The deminet docker network is the network the microservices use to communicate with each other. It has to be created once on every host running docker containers. You can do so with:

docker network create deminet
ERROR: while creating mount source path ... permission denied

When trying to access a bind-mount on some drives the following error might occur during the execution of the config script:

docker: Error response from daemon: error while creating mount source path ... permission denied.

This issue is caused when the docker user has no rights on the mounted drive.

Some containers like mariadb for the configdb or portainer need a bind-mount to persistently save their data. To fix this issue for these containers please make sure to use a directory where the root user has access. By default most compose files use the directory of the microservice/deployment stack is used. You can change the mount location directly in the compose file under volumes.