Skip to content

pkg: package complete contrib dir in new separate package#2614

Merged
sebix merged 1 commit intocerttools:developfrom
sebix:pkg-contrib
Jul 17, 2025
Merged

pkg: package complete contrib dir in new separate package#2614
sebix merged 1 commit intocerttools:developfrom
sebix:pkg-contrib

Conversation

@sebix
Copy link
Member

@sebix sebix commented May 7, 2025

server all contrib/ contents in a new package intelmq-contrib

@sebix sebix added this to the 3.4.1 Patch release milestone May 7, 2025
@sebix sebix added the packaging label May 7, 2025
@sebix sebix marked this pull request as ready for review May 7, 2025 10:51
@kamil-certat
Copy link
Contributor

What is the reason about that?

@sebix
Copy link
Member Author

sebix commented May 7, 2025

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.

@sebix
Copy link
Member Author

sebix commented May 25, 2025

this will fix #1591


### 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see the documentation in the packaged files 🤔 man pages generated from mkdocs would be something cool

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@sebix sebix merged commit 6d7acf3 into certtools:develop Jul 17, 2025
20 of 21 checks passed
@sebix sebix deleted the pkg-contrib branch July 17, 2025 19:30
@sebix sebix mentioned this pull request Jul 30, 2025
3 tasks
@sebix sebix self-assigned this Sep 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants