Merge: merge agent-python3 to master for version 1.0.0

hep-gc / shoal

A squid cache publishing and advertising tool designed to work in fast changing environments

Apache License 2.0

4 stars 8 forks source link

Merge: merge agent-python3 to master for version 1.0.0 #159

Closed MCatherine1994 closed 3 years ago

MCatherine1994 commented 3 years ago

Summary of changes on shoal-agent:

Updated to support both python2 and python3
Added broadcast functionality
Added auto configuration of the ips, port number, etc... and removed the setting of global/domain access
Added simple functional test for the running squid
Added email notification for the unavailable squid
Update to only accept configuration file at /etc/shoal/ directory
Added a bash installation script that could auto copy files; create user/group; handle log file; support backup of user's existing config file, and walk through the config options with them, allow them to enter the values, and rewrite the config file for them; restart the application
Added readme to pypi project description
Updated version to 1.0.0

MCatherine1994 commented 3 years ago

Installation Requirements:

Packages for python2: epel-release (for python-pip), python-pip, python-netifaces, python-pika
Packages for python3: python3, python3-pip
Make a directory /etc/shoal/, and a directory /etc/sysconfig/shoal/, copy config files to proper locations
Create user and group shoal
Create a file /var/log/shoal_agent.log, change the owner to shoal

Todo: discuss the location of config files, whether install them directly to the proper location or install them at one location and let the user copy them to the proper place

colsond commented 3 years ago

remove sysconfig file (and references in init//service files) Change init//service file user to shoal. Post install script to: -First thing stop agent (service shoal-agent stop) -create shoal user/grp -create/change owner of log file -conditionally copy config file -copy all data files to proper locations (currently using setup.py's data_files) start service

MCatherine1994 commented 3 years ago

python2 will install shoal-agent-installation command to /usr/bin/shoal-agent-installation python3 will install shoal-agent-installation command to /usr/local/bin/shoal-agent-installation, and to run this command, need to use "sudo su -"

also found that in setup.py file, data_file option we set the destination to be "share/shoal-agent", this is different in python2 and python3 when using pip install. For python2, our config files will be placed at "/usr/share/shoal-agent/", but for python3, they will be at "/usr/local/share/shoal-agent/". (As run "setup.py install" won't do anything about the data_file option, I didn't notice this at the beginning)

MarcusEbert commented 3 years ago

It should be possible to force a specific install dir for both version of python by using the "--prefix" option of pip, e.g. "--prefix=/usr" should install in /usr/bin/ "--prefix=/usr/local" should install in /usr/local/bin/

MCatherine1994 commented 3 years ago

config file path

[x] only consider the one in /etc/shoal/, update config.py and the readme
[x] update shoal-installation-script to print the info let the user know we are now only look at the config file in /etc/shoal/

how to run the shoal-agent-installation

[x] for python3, shoal-agent-installation will be installed at /usr/local/bin, so update readme to specify that run the command in this way "/usr/local/bin/shoal-agent-installation shoal-agent-installation"
[x] for python2, shoal-agent-installation will be installed at /usr/bin/, so could run it directly

data file locations

[x] data_files option in setup.py its path is relative to the sys.prefix, so will be relative to '/usr' for python2, and '/usr/local' for python3. In order to find out where the config files installed, decides to use 'pip show' to identify shoal-agent package is installed by python2 or python3, if both installed, use the one with the latest version
[x] test with pip/pip3 install