-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
3598e8e
known issue documentation for Vault 1.15 related to file audit device…
6859a16
Merge remote-tracking branch 'origin/main' into docs/peteski22/audit-…
7a098a4
fix caps in URL anchor
1c86bc9
Merge branch 'main' into docs/peteski22/audit-file-sighup-issue
ee168f3
Merge branch 'main' into docs/peteski22/audit-file-sighup-issue
c337e28
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
bfd78bf
PR feedback
ad90961
Warning not Important tag
e5b08fa
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
ed58be3
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
890dcda
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
302b9bf
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
5e7b7c6
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
bfecbba
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
936d75d
Update website/content/partials/known-issues/1_15-audit-file-sighup-d…
7545d4c
changes to known issue doc
4259c44
changes to known issue doc - 2
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
...ontent/partials/known-issues/1_15-audit-file-sighup-does-not-trigger-reload.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
### File audit devices do not honor SIGHUP signal to reload | ||
|
||
#### Affected versions | ||
|
||
- 1.15.0 | ||
|
||
#### Issue | ||
|
||
The new underlying event framework for Vault causes Vault to continue using | ||
audit logs instead of reopening the file paths even when you send | ||
[`SIGHUP`](/vault/docs/audit/file#log-file-rotation) after log rotation: | ||
|
||
- If you move or rename your audit log file, Vault continues to log data to the | ||
moved file. For example, if you archive the log file | ||
`audit/log/path/vault-audit.log` by moving it to | ||
`audit/log/archive/path/vault-audit.log.bak`, Vault continues to write data to | ||
`audit/log/archive/path/vault-audit.log.bak` instead of starting a fresh log | ||
at `audit/log/path/vault-audit.log`. | ||
- If you delete your audit log file, Vault continues to write data to the | ||
deleted file, which will continue to consume disk space as it grows. When | ||
Vault is sealed or restarted, the OS will perform junk collection on the | ||
deleted file and you will lose all data logged the audit file after it was | ||
tagged for deletion. | ||
|
||
<Warning title="You may lose audit entries"> | ||
If you delete the audit file on rotation, rather than moving it, you | ||
will lose any entries written by Vault after rotation when the OS | ||
permanently deletes the file. | ||
</Warning> | ||
|
||
The issue with file audit devices not honoring SIGHUP signals is fixed as a patch release in Vault `1.15.1`. | ||
|
||
#### Workaround | ||
|
||
If your Vault cluster uses any `file` audit devices, 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. | ||
|
||
|
||
<Note title="Temporary workaround"> | ||
The `VAULT_AUDIT_DISABLE_EVENTLOGGER` environment variable | ||
is a temporary solution and will be removed in a future release of Vault. | ||
<Note> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.