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

Docs: known issue - audit file reload on SIGHUP #23608

Merged
merged 17 commits into from
Oct 11, 2023

Conversation

peteski22
Copy link

@peteski22 peteski22 commented Oct 11, 2023

Documentation to describe a known issue which has been reported where Vault file audit devices do no honor reopening after Vault processes a SIGHUP command.

PR: #23598
Issue: #23596

Release notes: https://vault-git-docs-peteski22audit-file-sighup-issue-hashicorp.vercel.app/vault/docs/release-notes/1.15.0
Upgrade guide: https://vault-git-docs-peteski22audit-file-sighup-issue-hashicorp.vercel.app/vault/docs/upgrading/upgrade-to-1.15.x#file-audit-devices-do-not-honor-sighup-signal-to-reload

@peteski22 peteski22 added docs core/audit hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed backport/1.15.x labels Oct 11, 2023
@peteski22 peteski22 added this to the 1.15.1 milestone Oct 11, 2023
@peteski22 peteski22 marked this pull request as ready for review October 11, 2023 15:47
@peteski22 peteski22 requested a review from a team as a code owner October 11, 2023 15:47
…oes-not-trigger-reload.mdx

Co-authored-by: Nick Cabatoff <[email protected]>
Comment on lines 23 to 25
If audit log rotation is a requirement for your Vault deployment, you can use the
following environment variable set to `true` in order to disable the new underlying
event framework Vault uses to process audit events.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If audit log rotation is a requirement for your Vault deployment, you can use the
following environment variable set to `true` in order to disable the new underlying
event framework Vault uses to process audit events.
If you use log rotation with `file` audit devices, set the
`VAULT_AUDIT_DISABLE_EVENTLOGGER` environment variable to `true` to disable the
new underlying event framework for
processing audit events:
```shell-session
$ export VAULT_AUDIT_DISABLE_EVENTLOGGER=true
```

…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
Peter Wilson and others added 3 commits October 11, 2023 17:53
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
Peter Wilson and others added 2 commits October 11, 2023 18:06
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>
…oes-not-trigger-reload.mdx

Co-authored-by: Sarah Chavis <[email protected]>

#### Workaround

If your Vault cluster uses any `file` audit devices, you can use the following
Copy link
Collaborator

Choose a reason for hiding this comment

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

"If your Vault cluster uses any file audit devices" is really about whether you should be worried about the bug, so it probably doesn't belong in the Workaround section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core/audit docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants