Skip to content

Commit 400f3b2

Browse files
authored
update rotation documentation to include reference to logging (#893)
2 parents 44a1e81 + 0fc1c47 commit 400f3b2

File tree

8 files changed

+56
-2
lines changed

8 files changed

+56
-2
lines changed

content/vault/v1.19.x/content/docs/auth/ldap.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,8 @@ Use `vault path-help` for more details.
184184
The root bindpass can be rotated to a Vault-generated value that is not accessible by the operator.
185185
This will ensure that only Vault is able to access the "root" user that Vault uses to manipulate credentials.
186186

187+
Vault logs manual root rotations to `vault.log` with a note that the rotation was `on user request`.
188+
187189
```shell-session
188190
vault write -f auth/ldap/config/rotate-root
189191
```
@@ -231,6 +233,8 @@ TTL.
231233
For more details on rotating root credentials in the Azure plugin, refer to the
232234
[Root credential rotation](/vault/api-docs/auth/ldap#rotate-root) API docs.
233235

236+
@include 'rotation-manager-logging.mdx'
237+
234238
## Examples:
235239

236240
### Scenario 1

content/vault/v1.19.x/content/docs/secrets/databases/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ TTL.
104104
For more details on rotating root credentials in the DB Secrets engine, refer to the
105105
[Rotate Root credentials](/vault/api-docs/secret/databases#rotate-root-credentials) API docs.
106106

107-
107+
@include 'rotation-manager-logging.mdx'
108108

109109
## Setup
110110

@@ -296,6 +296,8 @@ or otherwise, it will not be rotated until the next scheduled rotation.
296296
!> The `rotation_period` and `rotation_schedule` fields are
297297
mutually exclusive. One of them must be set but not both.
298298

299+
Vault logs rotations with reference to the `name` of the role and `error` if the rotation failed. The logs also indicate if the rotation was part of a `periodic function`.
300+
299301
## Password generation
300302

301303
Passwords are generated via [Password Policies](/vault/docs/concepts/password-policies).

content/vault/v1.19.x/content/docs/secrets/ldap.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ TTL.
158158
For more details on rotating root credentials in the Azure plugin, refer to the
159159
[Root credential rotation](/vault/api-docs/secret/ldap#rotate-root) API docs.
160160

161+
@include 'rotation-manager-logging.mdx'
162+
161163
## Static credentials
162164

163165
### Setup
@@ -194,11 +196,17 @@ role, the response will include the time before the next rotation (`ttl`).
194196
The `binddn` account used by Vault should be rotated using the `rotate-root` endpoint to generate a password
195197
only Vault will know.
196198

199+
As with the rotation manager, Vault logs rotations with reference to the
200+
`name` of the role and `error` if the rotation failed. The logs also indicate
201+
if the rotation was part of a `periodic function`.
202+
197203
### Manual rotation
198204

199205
Static roles can be manually rotated using the `rotate-role` endpoint. When manually
200206
rotated the rotation period will start over.
201207

208+
Logging for manual rotation records the same information as other rotation logging with an additional reference that the rotation happened `on user request`.
209+
202210
### Deleting static roles
203211

204212
Passwords are not rotated upon deletion of a static role. The password should be manually
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Rotation logging
2+
3+
The rotation manager emits logs to the standard `vault.log` on any successful or
4+
failed rotation.
5+
6+
In the case of success, Vault notes:
7+
8+
- the rotated credential as the first parameter, `rotationID`.
9+
- the anticipated time of the next rotation as `expire_time`.
10+
11+
In the case of failure, Vault sets `rotationID` to `err` and may emit additional
12+
logs depending on the configured log level.

content/vault/v1.20.x/content/docs/auth/ldap.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,8 @@ This will ensure that only Vault is able to access the "root" user that Vault us
198198
vault write -f auth/ldap/config/rotate-root
199199
```
200200

201+
Vault logs manual root rotations to `vault.log` with a note that the rotation was `on user request`.
202+
201203
### Schedule-based root credential rotation
202204

203205
@include 'alerts/enterprise-only.mdx'
@@ -241,6 +243,8 @@ TTL.
241243
For more details on rotating root credentials in the Azure plugin, refer to the
242244
[Root credential rotation](/vault/api-docs/auth/ldap#rotate-root) API docs.
243245

246+
@include rotation-manager-logging.mdx
247+
244248
## Examples:
245249

246250
### Scenario 1

content/vault/v1.20.x/content/docs/secrets/databases/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ TTL.
105105
For more details on rotating root credentials in the DB Secrets engine, refer to the
106106
[Rotate Root credentials](/vault/api-docs/secret/databases#rotate-root-credentials) API docs.
107107

108+
@include 'rotation-manager-logging.mdx'
109+
108110
## Setup
109111

110112
Most secrets engines must be configured in advance before they can perform their
@@ -397,6 +399,8 @@ or otherwise, it will not be rotated until the next scheduled rotation.
397399
!> The `rotation_period` and `rotation_schedule` fields are
398400
mutually exclusive. One of them must be set but not both.
399401

402+
Vault logs rotations with reference to the `name` of the role and `error` if the rotation failed. The logs also indicate if the rotation was part of a `periodic function`.
403+
400404
## Password generation
401405

402406
Passwords are generated via [Password Policies](/vault/docs/concepts/password-policies).

content/vault/v1.20.x/content/docs/secrets/ldap.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,11 @@ of the root credential until the field is reset to `false`. If you use
155155
`rotation_period`, setting `disable_automated_rotation` also resets the credential
156156
TTL.
157157

158-
For more details on rotating root credentials in the Azure plugin, refer to the
158+
For more details on rotating root credentials in the LDAP plugin, refer to the
159159
[Root credential rotation](/vault/api-docs/secret/ldap#rotate-root) API docs.
160160

161+
@include 'rotation-manager-logging.mdx'
162+
161163
## Static credentials
162164

163165
### Setup
@@ -194,11 +196,17 @@ role, the response will include the time before the next rotation (`ttl`).
194196
The `binddn` account used by Vault should be rotated using the `rotate-root` endpoint to generate a password
195197
only Vault will know.
196198

199+
As with the rotation manager, Vault logs rotations with reference to the
200+
`name` of the role and `error` if the rotation failed. The logs also indicate
201+
if the rotation was part of a `periodic function`.
202+
197203
### Manual rotation
198204

199205
Static roles can be manually rotated using the `rotate-role` endpoint. When manually
200206
rotated the rotation period will start over.
201207

208+
Logging for manual rotation records the same information as other rotation logging with an additional reference that the rotation happened `on user request`.
209+
202210
### Deleting static roles
203211

204212
Passwords are not rotated upon deletion of a static role. The password should be manually
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Rotation logging
2+
3+
The rotation manager emits logs to the standard `vault.log` on any successful or
4+
failed rotation.
5+
6+
In the case of success, Vault notes:
7+
8+
- the rotated credential as the first parameter, `rotationID`.
9+
- the anticipated time of the next rotation as `expire_time`.
10+
11+
In the case of failure, Vault sets `rotationID` to `err` and may emit additional
12+
logs depending on the configured log level.

0 commit comments

Comments
 (0)