Documentation update

[mcgege]

Complement missing parameters / description in README

[mcgege]

BTW: why are there two parameters to prevent core dumps?

• enable_core_dump
• allow_core_dumps

[artem-sidorenko]

@mcgege many thanks for this PR!

@bitvijays I'll have a look to all PRs from @mcgege. Could you maybe review them too?

[bitvijays]

@mcgege Thank you for updating the ReadMe. Regarding enable_core_dump and allow_core_dump:

enable_core_dump is to control the sysctl manifest whereas allow_core_dump is to control the profile manifest file. ( both present in the init.pp). The comment in profile.conf ( file deployed for allow_core_dump ) is "Disable core dumps via soft limits for all users. Compliance to this setting is voluntary and can be modified by users up to a hard limit. This setting is a sane default.". Seems there is issue raised for this? #68

@artem-sidorenko Do you have more information about this? Also, the changes seems fine ( Updates in ReadMe only)

[mcgege]

@bitvijays Thanks for the clarification ... but I still don't see the point in having two distinct switches here :-)
I would expect a switch that either completely prevents core dump creation or leaves it untouched.

And regarding the issue #68 I guess this: with enable_core_dump / allow_core_dumps = false (the default) the files are created, and if you change afterwards to true the files are not deleted (submitted #91 to fix this) ...

[artem-sidorenko]

I'll have a look here somewhere today/tomorrow

[artem-sidorenko]

indeed we have here two switches more or less for the same thing. I checked this with chef-os-hardnening, all this things are matched to one option enable_core_dump.

My sugeestion would be to keep enable_core_dump and to remove/replace the allow_core_dumps

@mcgege @bitvijays what do you think?

[artem-sidorenko]

I merged #91 to avoid any conflicts

[mcgege]

That's fine for me ... I'll provide a PR the next days for this and change the documentation

[mcgege]

Removed allow_core_dumps from documentation

[mcgege]

@bitvijays How about merging this? I just cleaned up the conflict ...

[bitvijays]

Thanks @mcgege for the PR. Merged :)