Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

LabelDefaultDescription
registry.porttraefik.port or 80The port which the service exposes as the main endpoint
registry.frontendtraefik.frontend.rule parsedThe frontend url under which this service is reachable
registry.enabletraefik.enable or falseWhether the service is reachable through the frontend
registry.categories[ ]

An array of strings and priorities which determines the categories this microservice belongs to

Example: "registry.categories=(events, 10);(notifications, 10)"

registry.description""A description for this service

servicename

The servicename is parsed directly from what is set as a servicename in docker-compose.yml and cannot be altered

registry.modules""

If this service wants to register frontend pages, this should be the relative path where it serves a getModules.json. Do not prepend http://<servicename>:<port> this will be added automatically from the above fields

Example: /frontend/getModules.json → registry queries http://omsevents-frontend:8083/frontend/getModules.json

How to use getModules.json is described here

registry.status"/status"

An endpoint that upon a GET request delivers whether the service is up and healthy or not. Connection refused is interpreted as a no. Extra information can be delivered, but the success field is indicating the actual status response

Code Block
{success: 1, data: <extra information>}



Code

API

Questions

I (Derk Snijders) read Micro service - communication, went through the code and looked at the API, yet still had some questions. Answering these should provide solid documentation as to how to use the registry.

...