2021) v2021.1 Switch to the latest release

Published on: 31/03/2021 Last update: 10/03/2023

Version summary

The version published at this time contains breaking and non-breaking changes.

New Features

ATS:

ETS:

Bugfixes

#419 Updated CharacterString validation dor MD 2.0 3.4 - #581
#461 Updated TeamEngine dependency
#471 Added SSL certificates to the validator deployment
#474 Updated HTTPS access to the TEAM engine
#479 Relaxed MD C.21 - C.22 - 1.10 - 5.3 - 5.4 - 5.5 - #597
#480 Relaxed error C.14 to allow before and after - #583
#482 Added SSL certificates to the validator deployment
#488 Added certificates in validation process
#512 Added BuildingPart Default layer and set 'default' to upper case - #588
#518 Species distribution paths and wrongMultiplicity messages fixed - #582
#529 Modified el-gml path - #587

Deployment instructions

Section containing deployment process using Docker image and troubleshooting section. You can also find these in the training materal

As a prerrequisite to use the Docker packages from GitHub, you would need to create an access token as a way to authenticate on the registry. You can get more information here

docker login docker.pkg.github.com

#Provide Github credentials

docker run --name inspire-validator -d -p 8080:8080 -v ~/etf:/etf
docker.pkg.github.com/inspire-mif/helpdesk-validator/inspire-validator:2021.1

#Launches a container with the image, exposing it port 8080 through the same port in the host machine,
and uses a volume in the local file system, on the directory ~/etf

Modifying the Docker image

In the inspire-validator ZIP file you can find all the resources needed to generate the Docker image from this release. If you would like to tweak anything from it, you can modify any of its contents (Dockerfile, entrypoint file, configuration files... ), then execute the command

docker build -t [IMAGE_NAME]:[VERSION]

You can run this again using the run command

docker run --name inspire-validator -d -p 8080:8080 -v ~/etf:/etf [IMAGE_NAME]:[VERSION]

Deployment on the production host

The Docker image is set up to run at localhost to be deployed on any machine. However, users may need to acces their validator on a dedicated host, usually with a domain name. For proper functioning of the validator, their UI and correct rendering of Test Reports, validator needs to be configured to run on a domain.

If you want to run the webapp in another host, you can change the configuration file, inside the .war file inside the inspire-validator zip file accompanying this release, at WEB-INF/classes/etf-config.properties, and modify the etf.webapp.base.url property. Then you can proceed to the build process described in the previous point.

Exposing the validator through a proxy

Usually host machines are connected in a private network that access to the Internet through a proxy. The Docker client needs to be configured to make use of this proxy, in order to be able to build the image and set up running the container.

For the build process, you need to add the following arguments to the command

--build-arg http_proxy=[HTTP_PROXY_URL:PORT]  --build-arg
https_proxy=[HTTPS_PROXY_URL:PORT]  --build-arg no_proxy=127.0.0.1,localhost,*.<my-domain>

For the run command, you need to add the environment variables to it

--env http_proxy=[HTTP_PROXY_URL:PORT]  --env https_proxy=[HTTPS_PROXY_URL:PORT]
--env no_proxy=127.0.0.1,localhost,*.<mydomain>

These can also be set up in the Dockerfile, using the keyword ENV

For more information please check out https://docs.docker.com/network/proxy

For further configuration, please download the file inspire-validator-2021.1.zip and follow the instructions in the README.md file inside the .zip file.