myems-cleaning

MyEMS Cleaning Service

MyEMS 数据清洗服务

Introduction

This service is a component of MyEMS to clean the historical data.

Prerequisites

mysql-connector-python

schedule

python-decouple

Quick Run for Development

cd myems/myems-cleaning
pip install -r requirements.txt
cp example.env .env
chmod +x run.sh
./run.sh

Installation

Option 1: Install myems-cleaning on Docker

In this section, you will install myems-cleaning on Docker.

• Copy source code to root directory

On Windows:

cp -r myems/myems-cleaning c:\
cd c:\myems-cleaning

On Linux:

cp -r myems/myems-cleaning /
cd /myems-cleaning

• Create .env file based on example.env file

Manually replace 127.0.0.1 with real HOST IP address.

cp example.env .env

• Build a Docker image

docker build -t myems/myems-cleaning .

To build for multiple platforms and not only for the architecture and operating system that the user invoking the build happens to run. You can use buildx and set the --platform flag to specify the target platform for the build output, (for example, linux/amd64, linux/arm64, or darwin/amd64).

docker buildx build --platform=linux/amd64 -t myems/myems-cleaning .

• Run a Docker container on Linux (run as superuser)

docker run -d -v /myems-cleaning/.env:/code/.env:ro --log-opt max-size=1m --log-opt max-file=2 --restart always --name myems-cleaning myems/myems-cleaning

• Run a Docker container on Windows (Run as Administrator)

docker run -d -v c:\myems-cleaning\.env:/code/.env:ro --log-opt max-size=1m --log-opt max-file=2 --restart always --name myems-cleaning myems/myems-cleaning

• -d Run container in background and print container ID

• -v If you use -v or --volume to bind-mount a file or directory that does not yet exist on the Docker host, -v creates the endpoint for you. It is always created as a directory. The ro option, if present, causes the bind mount to be mounted into the container as read-only.

• --log-opt max-size=2m The maximum size of the log before it is rolled. A positive integer plus a modifier representing the unit of measure (k, m, or g).

• --log-opt max-file=2 The maximum number of log files that can be present. If rolling the logs creates excess files, the oldest file is removed. A positive integer.

• --restart Restart policy to apply when a container exits

• --name Assign a name to the container

The absolute path before colon is for path on host and that may vary on your system. The absolute path after colon is for path on container and that CANNOT be changed. By passing .env as bind-mount parameter, you can change the configuration values later. If you changed .env file, restart the container to make the change effective.

• Immigrate the Docker container

To immigrate the container to another computer,

• Export image to tarball file

docker save --output myems-cleaning.tar myems/myems-cleaning

• Copy the tarball file to another computer, and then load image from tarball file

docker load --input .\myems-cleaning.tar

Installation Option 2: Online install on Ubuntu server with internet access

In this section, you will install myems-cleaning on Ubuntu Server with internet access.

cp -r myems-cleaning /myems-cleaning
cd /myems/myems-cleaning
pip install -r requirements.txt -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com

Copy exmaple.env file to .env and modify the .env file:

cp /myems-cleaning/example.env /myems-cleaning/.env
nano /myems-cleaning/.env

Setup systemd service:

cp myems-cleaning.service /lib/systemd/system/

Enable the service:

systemctl enable myems-cleaning.service

Start the service:

systemctl start myems-cleaning.service

Monitor the service:

systemctl status myems-cleaning.service

View the log:

cat /myems-cleaning.log

Installation Option 3: Offline install on Ubuntu server without internet access

In this section, you will install myems-cleaning on Ubuntu Server.

Download and install MySQL Connector:

cd ~/tools
wget https://cdn.mysql.com//Downloads/Connector-Python/mysql-connector-python-8.0.28.tar.gz
tar xzf mysql-connector-python-8.0.28.tar.gz
cd ~/tools/mysql-connector-python-8.0.28
python3 setup.py install

Download and install Schedule

cd ~/tools
git clone https://github.com/dbader/schedule.git
cd ~/tools/schedule
python3 setup.py install

Download and install Python Decouple

cd ~/tools
git clone https://github.com/henriquebastos/python-decouple.git
cd ~/tools/python-decouple
python3 setup.py  install

Install myems-cleaning service

cp -r myems/myems-cleaning /myems-cleaning
cd /myems-cleaning

Copy file example.env to .env and edit the .env file:

cp /myems-cleaning/example.env /myems-cleaning/.env
nano /myems-cleaning/.env

Setup systemd service:

cp myems-cleaning.service /lib/systemd/system/

Enable the service:

systemctl enable myems-cleaning.service

Start the service:

systemctl start myems-cleaning.service

Monitor the service:

systemctl status myems-cleaning.service

View the log:

cat /myems-cleaning.log

References

1. https://myems.io
2. https://dev.mysql.com/doc/connector-python/en/