Service Integration using OpenAgriBootstrap Deployment

[fedjo]

This issue will serve as a guide to integrate each service with the Gatekeeper using the bootstrap app.

The steps will be needed for each of the services to be integrated

• The docker image of each service must be uploaded and made public to OpenAgri Docker Registry. An example of pushing a docker image to GH registry can be found her. The idea is to tag the image with a name similar to ghcr.io/openagri-eu/<service-name>:latest and push it to registry.

docker tag pyweather-srv ghcr.io/openagri-eu/pyweather-srv:latest
docker push ghcr.io/openagri-eu/pyweather-srv:latest

Note: Please validate for Packages page that the image is public

• Create a YAML file (similar to docker-compose.yml of the service) and place it in the available_services directory. An example YAML file is here

Note: The YAML file must receive as environment variables JWT_SIGNING_KEY, ALLOWED_HOSTS and APP_PORT

Disclaimer:

JWT_SIGNING_KEY: Is the key needed for each service to validate(decrypt) the jwt token received from incoming requests from Gatekeeper. 

ALLOWED_HOSTS: Refers to a middleware implementation to only allow gatekeeper as a host, but for demo purposes we must allow all hosts to have direct access to each service

APP_PORT: Is the port where the application runs

INTERNAL_HOST_NAME: refers to the container name, used for internal DNS resolution, usually the same as the service name in the docker compose yml file. (i.e., farmcalendar, weathersrv, etc..)

@arruda @pranavnbapat @vlf-stefan-drobic
Please double check the process we discussed and give feedback

[arruda]

I would just suggest using the docker compose to build (and tag) and push the docker images, this avoid any mistakes in the naming of the tags, and instead you can just set it once in the docker-compose.yml file.

that is, along side the build option you put also the image option: https://github.com/openagri-eu/pest-and-disease-management/blob/main/compose.yaml#L19

then you can do docker compose build (backend in the case of the pest and disease management compose file)
and then do a docker compose push

[arruda]

and if possible please try to have the container image names the same as the repository, it avoids confusion:
so for example, for the https://github.com/openagri-eu/weather-service service this would mean the image name should be:
ghcr.io/openagri-eu/weather-service:latest

[arruda]

And @fedjo, just to complement your detailed instructions, for the people using FastAPI the middleware you are looking for should be this one:
https://fastapi.tiangolo.com/advanced/middleware/#trustedhostmiddleware

[arruda]

A part from these small details I would say the instructions are clear and precise 👍

[arruda]

@fedjo I just updated the instructions to also include a new env variable: INTERNAL_HOST_NAME
this should be what will be used when the service registers in the gatekeeper, so for example the farmcalendar will register it self in the gatekeeper using INTERNAL_HOST_NAME=farmcalendar. So when registering itself it would use something like: "base_url": "http://farmcalendar:8003/" since the service name for the farm calendar in the docker compose file is farmcalendar.