Branch	Status
develop
master

• Table of content
• Description
• Versioning
• Local Development
  • Make Dependencies
  • Setting up to work
    • Database access
  • Linting and formatting your work
  • Test your work
• Docker
• Deployment
  • Deployment configuration

This is the SearchServer service from mf-chsdi3. How the service can be queried, is currently described here: api3.geo.admin.ch/search. But this will have to be migrated in some way to this repository. This service is a simple Flask Application that query a Sphinx Search Server. Currently supported Sphinx Search server is v2.2.11.

This service uses SemVer as versioning scheme. The versioning is automatically handled by .github/workflows/main.yml file.

See also Git Flow - Versioning for more information on the versioning guidelines.

The Make targets assume you have python3.9, pipenv, bash, curl and docker installed.

First, you'll need to clone the repo

git clone [email protected]:geoadmin/service-search-wsgi

Then, you can run the setup target to ensure you have everything needed to develop, test and serve locally

Virtual environment to develop and debug the service

make setup

To run the service you will have to adapt .env.local, which is a copy of .env.default And to set the variables.

For local development you will need access to a running sphinx search server and to the database. To do so you can use ssh port forwarding to the DB and to the current sphinx deployment server.

Right now the database BOD is being accessed , to retrieve the and to do on labels.

In order to have a consistent code style the code should be formatted using yapf. Also to avoid syntax errors and non pythonic idioms code, the project uses the pylint linter. Both formatting and linter can be manually run using the following command:

make format-lint

Formatting and linting should be at best integrated inside the IDE, for this look at Integrate yapf and pylint into IDE

Testing if what you developed work is made simple. You have four targets at your disposal. test, serve, gunicornserve, dockerrun

make test

This command run the unit tests.

summon make serve

This will serve the application through Flask without any wsgi in front.

summon make gunicornserve

This will serve the application with the Gunicorn layer in front of the application

summon make dockerrun

This will serve the application with the wsgi server, inside a container.

The service is encapsulated in a Docker image. Images are pushed on the swisstopo-bgdi-builder account of AWS ECR registry. From each github PR that is merged into develop branch, one Docker image is built and pushed with the following tags:

• develop.latest
• CURRENT_VERSION-beta.INCREMENTAL_NUMBER

From each github PR that is merged into master, one Docker image is built an pushed with the following tag:

• VERSION

Each image contains the following metadata:

• author
• git.branch
• git.hash
• git.dirty
• version

These metadata can be seen directly on the dockerhub registry in the image layers or can be read with the following command

# NOTE: jq is only used for pretty printing the json output,
# you can install it with `apt install jq` or simply enter the command without it
docker image inspect --format='{{json .Config.Labels}}' 974517877189.dkr.ecr.eu-central-1.amazonaws.com/service-search-wsgi:develop.latest | jq

You can also check these metadata on a running container as follows

docker ps --format="table {{.ID}}\t{{.Image}}\t{{.Labels}}"

This service is going to be deployed on a vhost. The configuration of the docker-compose.yml of the vhost setup is going to be here: https://github.com/geoadmin/infra-vhost

The service is configured by Environment Variable: