Skip to content

DEV_README.md

Latest commit

 

History

History
53 lines (41 loc) · 1.9 KB

DEV_README.md

File metadata and controls

53 lines (41 loc) · 1.9 KB
Raw

Build & Development of redis writer package

Docker

You can use docker_build.sh to build an image for local testing.

Once build you can run Docker image locally like so:

docker run -it --rm -v ./settings.yaml:/code/ starwitorg/sae-redis-writer:1.3.0

Please note, that you should provide a settings.yaml that configures application to your needs. See template for how to do that.

APT package

This software can be released as a Debian/APT package. This section explains, how this works. Please note, that everything has been tested with Ubuntu Linux only.

Following packages need to installed on your computer:

  • build-essential
  • python3-all
  • python3-setuptools
  • python3-pip
  • dh-python

Package can be build using:

make build-deb

Package can be found in folder target. You can test install package using Docker like so:

docker run -it --rm -v ./:/app  ubuntu:22.04 bash
apt update && apt install -y /app/target/rediswriter_1.3.0_all.deb

Note: Installation will fail when trying to start SystemD service. This is something one can only test in a real Linux environment.

make clean

Config files for packaging

Files in the debian/ folder:

  • changelog - Records changes made to the package in each version
  • compat - Specifies the debhelper compatibility level
  • control - Contains package metadata (dependencies, description, etc.)
  • install - Lists files to be installed and their destination paths
  • objectdetector.service - Systemd service file for the application
  • postinst - Post-installation script that runs after package installation
  • preinst - Pre-installation script that runs before package installation
  • prerm - Pre-removal script that runs before package removal
  • rules - Main package build script (makefile)
  • source/options - Options for the source package format like ommiting directories