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
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/content/docs/release-notes/1.15.0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Version | Issue
------- | -----
1.15.0+ | [Vault no longer reports rollback metrics by mountpoint](/vault/docs/upgrading/upgrade-to-1.15.x#rollback-metrics)
1.15.0 | [Panic in AWS auth method during IAM-based login](/vault/docs/upgrading/upgrade-to-1.15.x#panic-in-aws-auth-method-during-iam-based-login)
1.15 | [Vault file audit devices do not honor SIGHUP signal to reload](/vault/docs/upgrading/upgrade-to-1.15.x#file-audit-devices-do-not-honor-sighup-signal-to-reload)

## Vault companion updates

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.15.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,5 @@ option.
@include 'known-issues/transit-managed-keys-sign-fails.mdx'

@include 'known-issues/aws-auth-panics.mdx'

@include 'known-issues/1_15-audit-file-sighup-does-not-trigger-reload.mdx'
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
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.

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>