[NEW-PORT] sysutils/data-prepper: Opensearch Data Prepper

[kiwi]

Summary

systils/data-prepper: Opensearch Data Prepper

Data Prepper is a server-side data collector
capable of filtering, enriching, transforming, normalizing,
and aggregating data for downstream analysis and visualization.

Sponsored by:   Klara, Inc.
Approved by:    0mp (mentor)
Approved by:    kevans 
Approved by:    opensearch (Sven Ruediger <[e-mail]>)
Co-authored-by: kiwi

Test Plan

• Tested with poudriere on 14.2
• Pet portclippy and portlint (except USE_JAVA -> USES+= java)
• Basic install on a jail

[0mp]

Thanks for taking care of this patch.

I posted some comments with suggestions.

Note regarding the location of files: the port installs pretty much everything into its DATADIR. The FreeBSD convention is that we should sort and install files into proper directories, e.g., DATADIR, EXAMPLESDIR, ETCDIR, etc. What comes to my mind is that %%DATADIR%%/pipelines should probably live in ETCDIR and %%DATADIR%%/examples in EXAMPLESDIR. Sometimes, of course, the port is not easy to modify to follow this convention. I leave it up to your discretion to decide if we should install those files into the proper directories.

sysutils/data-prepper/Makefile

10

COMMENT should not be just the name of the program. See https://docs.freebsd.org/en/books/porters-handbook/makefiles/#makefile-comment

24

Is it necessary to set DATADIR here? Isn't the default OK?

36

Seems like a leftover debug command.

49

Please use ${RLN} instead of ${INSTALL} -lrs (defined in Mk/bsd.commands.mk).

sysutils/data-prepper/files/data-prepper.in

30

This should be %%SEARCHUSER%%

31

This should be %%SEARCHGROUP%%

34

%%JAVA_HOME%% is probably better to avoid problems in the future.

sysutils/data-prepper/pkg-messsage

4 ↗

(On Diff #150670)

Please use %%PREFIX%% here. You'll need to switch to pkg-message.in. See math/scalapack for example.

[diizzy]

sysutils/data-prepper/Makefile

9

Is this a valid group/user?

[kiwi]

sysutils/data-prepper/Makefile

9

Well it seem to have a opensearch group: https://wiki.freebsd.org/OpenSearch

[kiwi]

All suggestion are done. See updates

[kiwi]

Updated port with suggestions from 0mp
Fixed distfile name that have changed on master site
Updated pkg-plist as well

[kiwi]

Remove unused comment.

[kevans]

sysutils/data-prepper/Makefile

42

This should probably be using ${EXAMPLESDIR} instead of ${DATADIR}/examples, to follow normal FreeBSD convention. Below examples/ copy split out, and plist entries replaced with %%EXAMPLESDIR%%, etc. Mateusz had mentioned this (and a similar concern with /pipelines, but I bet that one requires patching and isn't worth it), but I didn't really see a comment explaining why we've opted not to go that route.

[diizzy]

sysutils/data-prepper/Makefile

7

${DISTVERSION}${DISTVERSIONSUFFIX} --> ${DISTVERSIONFULL}

sysutils/data-prepper/files/pkg-messsage.in

5

If its wip it shouldn't be committed to tree

[kevans]

sysutils/data-prepper/files/pkg-messsage.in

5

There's nothing wrong with iterating on a port.
Obviously it's been smoke-tested and it functions, we can't predict all of the more in-depth usage that may need a little more work, and that's fine.

[kiwi]

All suggestion has been updated

sysutils/data-prepper/Makefile

42

Well in this case, the original port give to us was made in this way. Will fix and update this port.

sysutils/data-prepper/files/pkg-messsage.in

5

Well you are right we can remove this comment since we took the work to make this port very less experimental.

[kiwi]

Suggestion for examples has been done (changed also plist, and the way to install examples into ${EXAMPLESDIR}).
Aslo updated pkg-message.in to reflect this change, and removed the "experimental" line.
Updated ${DISTNAME} as suggested.

[diizzy]

Needs proper confirmation from assigned group

sysutils/data-prepper/Makefile

9

..and did anyone agree to this assignment?

[kevans]

sysutils/data-prepper/Makefile

9

Yes, we're doing this on behalf of one of the members.

[admin_hackacad.net]

In D48883#1119099, @diizzy wrote:

Needs proper confirmation from assigned group

Yes, this port was initially created by me and the other members agreed to maintain this as the opensearch@ group.

sysutils/data-prepper/Makefile

9

Yes it is.

See textproc/opensearch

https://wiki.freebsd.org/OpenSearch

[diizzy]

Thanks for confirming, this information should be in commit message

[admin_hackacad.net]

As this port has not been widely tested I'd suggest to add a pkg-message as well.

https://github.com/opensearch-freebsd/freebsd-ports/blob/main/sysutils/data-prepper/pkg-messsage

sysutils/data-prepper/files/data-prepper.in

31

It looks like the RC script is not properly resolving %%SEARCHUSER%% and %%SEARCHGROUP%%, leaving these variables in their unresolved state instead of substituting them with actual values.

[kiwi]

Updated commit message to include the information about opensearch (Sven Ruediger <[e-mail]>) approbatiion.
Updating of %%JAVA_HOME%%, %%SEARCHUSER%% and %%SEARCHGROUP%% in rc script.

[kiwi]

In D48883#1119113, @diizzy wrote:

Thanks for confirming, this information should be in commit message

Hey @diizzy, I have added the proper "Approved by" line about this point. Is it good to go for you ?

[0mp]

sysutils/data-prepper/files/data-prepper.in

35

BTW, if lib/data-prepper is installed by this port, then it should be PREFIX not LOCALBASE.

[kiwi]

Changed %%LOCALBASE%% to %%PREFIX%% in rc file

[0mp]

diizzy's concerns seem to be addressed. Approved.

[kiwi]

sysutils/data-prepper/files/data-prepper.in

35

Nice catch, thanks :)

[kiwi]

Adding USERS and GROUPS names to be created

[admin_hackacad.net]

LGTM
Approved by opensearch@