Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

contrib: add example startup configuration for macOS #3172

Merged
merged 2 commits into from Mar 17, 2020

Conversation

rcmelendez
Copy link
Contributor

Hi all! Per @furiel comments in the Gitter channel, I'm sharing a working launchd job for syslog-ng 3.25 I tested on macOS. I'm just trying to give Mac users a little help with their syslog-ng experience :)

@kira-syslogng
Copy link
Contributor

This user does not have permission to start the build. Can one of the admins verify this patch and start the build?
(admin: you have the next options (make sure you checked the code):
"ok to test" to accept this pull request (and further changes) for testing
"test this please" for a one time test run
"add to whitelist" add author of a Pull Request to whitelist (globally, be careful, it means this user can trigger kira for any PR)
do nothing -> CI won't start)

2 similar comments
@kira-syslogng
Copy link
Contributor

This user does not have permission to start the build. Can one of the admins verify this patch and start the build?
(admin: you have the next options (make sure you checked the code):
"ok to test" to accept this pull request (and further changes) for testing
"test this please" for a one time test run
"add to whitelist" add author of a Pull Request to whitelist (globally, be careful, it means this user can trigger kira for any PR)
do nothing -> CI won't start)

@kira-syslogng
Copy link
Contributor

This user does not have permission to start the build. Can one of the admins verify this patch and start the build?
(admin: you have the next options (make sure you checked the code):
"ok to test" to accept this pull request (and further changes) for testing
"test this please" for a one time test run
"add to whitelist" add author of a Pull Request to whitelist (globally, be careful, it means this user can trigger kira for any PR)
do nothing -> CI won't start)

@rcmelendez rcmelendez changed the title Create com.oneidentity.syslog-ng.plist contrib/com.oneidentity.syslog-ng.plist: launchd job for macOS Mar 11, 2020
Copy link
Contributor Author

@rcmelendez rcmelendez left a comment

Choose a reason for hiding this comment

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

Signed-off-by: Roberto Meléndez rcmelendez@users.noreply.github.com

contrib/com.oneidentity.syslog-ng.plist Outdated Show resolved Hide resolved
@bazsi
Copy link
Collaborator

bazsi commented Mar 12, 2020

Ok to test

@kira-syslogng
Copy link
Contributor

Build SUCCESS

@furiel
Copy link
Collaborator

furiel commented Mar 12, 2020

@rcmelendez thank you for your PR.

We follow a few formal requirements about contributions. Unfortunately, our contribution guide is not up-to-date. I will update it soon. Until then, let me share what is needed to be changed.

Commit format

We use the following format for commit message:

module: short description

long description (optional)

Signed off line.

Signed off line is important, because sometimes the patches are moved around: rebased or cherrypicked, for example during backporting. So that we and github could track the original author, we use the signed off line. For example you can use something like this:

contrib: add example startup configuration for macOS

Signed-off-by: your name <youremail@address.com>

If you do not want to share your email due to privacy reasons, you can use
yourgithubusername@users.noreply.github.com, which is automatically generated and tracked by github.

This is needed for the commit checker ci job to pass.

News file

We are generating the newsfile after each release automatically. So that to work, you need to add a news entry into the news directory. You can already find some examples there.

In your case you could create

news/packaging-3172.md

with a content:

`macOS`: add example startup configuration.

If you put the news entry into a second patch, the commit format check needs to be passed on that too.

@kira-syslogng
Copy link
Contributor

Build SUCCESS

1 similar comment
@kira-syslogng
Copy link
Contributor

Build SUCCESS

contrib/com.oneidentity.syslog-ng.plist Outdated Show resolved Hide resolved
contrib/com.oneidentity.syslog-ng.plist Outdated Show resolved Hide resolved
contrib/com.oneidentity.syslog-ng.plist Outdated Show resolved Hide resolved
@bazsi
Copy link
Collaborator

bazsi commented Mar 12, 2020 via email

@furiel
Copy link
Collaborator

furiel commented Mar 13, 2020

Finally I could manage to get a working macOS environment and could test the config example. It worked for me (after editing the binary location to my custom install dir).

Me seems launchd does not support specifying stop or reload commands. I was hoping we could specify systemctl reload or stop. As I read from the manual, launchd just sends the term signal, and after the timeout, the kill signal. The only configurable thing is the timeout.

With that said, I am fine with the current feaute set.

@kira-syslogng
Copy link
Contributor

Build SUCCESS

@kira-syslogng
Copy link
Contributor

Build SUCCESS

@kira-syslogng
Copy link
Contributor

Build SUCCESS

@kira-syslogng
Copy link
Contributor

Build SUCCESS

furiel
furiel previously approved these changes Mar 16, 2020
@MrAnno MrAnno changed the title contrib/com.oneidentity.syslog-ng.plist: launchd job for macOS contrib: add example startup configuration for macOS Mar 16, 2020
Copy link
Collaborator

@MrAnno MrAnno left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution!

"One last thing" I've found is a PID name conflict, otherwise 👍 :)

contrib/com.syslog-ng.syslog-ng.plist Outdated Show resolved Hide resolved
Signed-off-by: Roberto Meléndez <rcmelendez@users.noreply.github.com>
Signed-off-by: Roberto Meléndez <rcmelendez@users.noreply.github.com>
@kira-syslogng
Copy link
Contributor

Build SUCCESS

@furiel furiel merged commit 4ce5889 into syslog-ng:master Mar 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants