pkg: package complete contrib dir in new separate package #2614
Conversation
|
What is the reason about that? |
|
contrib contain several useful scripts and all users of packages would need to download, install and regularly update them purely manually. For example the malware name mapping and eventdb scripts. packaging them (separatly) makes it way easier for them to use, and also increases the visibility of these scripts. |
|
this will fix #1591 |
| @@ -37,6 +37,7 @@ Please refer to the [NEWS](NEWS.md) for a list of changes which have an affect o | |||
|
|
|||
| ### Packaging | |||
| - Replace `/opt/intelmq` example paths in bots with variable `VAR_STATE_PATH` for correct paths in LSB-path setups like with packages (PR#2587 by Sebastian Wagner). | |||
| - New deb-package `intelmq-contrib` with all `contrib/` scripts and documentation (PR#2614 by Sebastian Wagner). | |||
There was a problem hiding this comment.
I don't see the documentation in the packaged files 🤔 man pages generated from mkdocs would be something cool
There was a problem hiding this comment.
I don't see the documentation in the packaged files 🤔
all contents of contrib/ are part of the package in the same structure, including their READMEs.
| contrib/example-extension-package/ /usr/share/intelmq/contrib/ | ||
| contrib/feeds-config-generator/ /usr/share/intelmq/contrib/ | ||
| contrib/logcheck/ /usr/share/intelmq/contrib/ | ||
| contrib/logrotate/ /usr/share/intelmq/contrib/ |
There was a problem hiding this comment.
Before approval, could you please clarify two things to me?
The two contrib directories: logrotate and malware_name_mapping looks to me like something that eventually should be included in the main package, shouldn't it? I thought those two things should be installed by defaults (or maybe there are separated files?). For the rest, I have no doubts (tbh, I could even just skip packaging them at all)
There was a problem hiding this comment.
The two contrib directories: logrotate and malware_name_mapping looks to me like something that eventually should be included in the main package, shouldn't it? I thought those two things should be installed by defaults (or maybe there are separated files?).
Regarding logrotate:
Maybe it's more complex. If the administrator chooses not to use logrotate, but systemd logging?
The logrotate rules had a semi-official status. Although they are in contrib (unofficial stuff), we used them in the packages (basically "official").
This PR actually doesn't remove the logrotate config from the main package. It is only added additionally to the contrib package, duplicating the content. I removed that line.
See also #1772
Regarding the malware name mapping scripts:
The maintenance and future of these scripts and the mapping itself are unclear, so I would have my concerns if we included them in the main package.
Follow-up question: Where do we draw the line between the main package and contributed stuff, without bloating the main package with small (potentially broken) scripts?
For the rest, I have no doubts (tbh, I could even just skip packaging them at all)
The rest is not of importance to me either, but it was cheap to add them as well.
server all contrib/ contents in a new package
intelmq-contrib