Skip to content

docs: clarify when plugin executables must also be given mlock syscall ability#9275

Merged
austingebauer merged 3 commits into
masterfrom
docs-plugins-mlock
Jun 22, 2020
Merged

docs: clarify when plugin executables must also be given mlock syscall ability#9275
austingebauer merged 3 commits into
masterfrom
docs-plugins-mlock

Conversation

@austingebauer
Copy link
Copy Markdown
Contributor

Closes #9257

This PR adds a note to the internals/plugins documentation to clarify when plugin executables must also be given the mlock syscall ability. It's not obvious that this is needed from the plugin documentation.

There currently is documentation stating that this is needed, but it's somewhat difficult to find in configuration#disable_mlock. See:

Note: Since each plugin runs as a separate process, you need to do the same for each plugin in your plugins directory.

I plan to update the ops-deployment-guide to mention this as well.

@austingebauer austingebauer requested a review from a team June 20, 2020 00:51
Copy link
Copy Markdown
Contributor

@catsby catsby left a comment

Choose a reason for hiding this comment

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

👍 we should also fix the formatting of the existing Note you mention, it doesn't have the ~> that triggers the CSS styling of a note

@austingebauer
Copy link
Copy Markdown
Contributor Author

austingebauer commented Jun 22, 2020

Good idea, @catsby. Done in 54a98d9. Thanks 👍

@austingebauer austingebauer merged commit 48bd627 into master Jun 22, 2020
@austingebauer austingebauer deleted the docs-plugins-mlock branch June 22, 2020 17:05
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.

Plugin docs unclear that the plugin also needs CAP_IPC_LOCK

2 participants