Skip to content

Commit a74b02d

Browse files
committed
COMP-264 WIP updating documentation for audit secret logging
- Extending audit_log.md to include secret audit events for GraphQL - Extending secrets.md to describe the feature itself
1 parent 4e3edf4 commit a74b02d

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

pages/pipelines/audit_log.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ SCM_PIPELINE_SETTINGS_UPDATED
7373
SCM_SERVICE_CREATED
7474
SCM_SERVICE_DELETED
7575
SCM_SERVICE_UPDATED
76+
SECRET_CREATED
77+
SECRET_DELETED
78+
SECRET_QUERIED
79+
SECRET_READ
80+
SECRET_UPDATED
7681
SSO_PROVIDER_CREATED
7782
SSO_PROVIDER_DELETED
7883
SSO_PROVIDER_DISABLED

pages/pipelines/secrets.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,47 @@ steps:
162162
https://api.github.com/repos/my-org/my-app/deployments
163163
```
164164
{: codeblock-file="pipeline.yml"}
165+
166+
## Audit Logging for Secrets
167+
[Audit Log](/docs/pipelines/audit-log) also includes the transactions in which secrets are accessed.
168+
169+
>📘 Secret audit logging does not contain the value of the secret.
170+
171+
172+
This enables visibility into which secrets were accessed by whom and when. The following operations will be audited:
173+
* Creating a secret:
174+
- **Who:**
175+
- **What:**
176+
- **Where:**
177+
- **When:**
178+
* Deleting a secret:
179+
- **Who:**
180+
- **What:**
181+
- **Where:**
182+
- **When:**
183+
* Reading the value of a secret:
184+
- **Who:**
185+
- **What:**
186+
- **Where:**
187+
- **When:**
188+
* Querying a secret:
189+
- **Who:**
190+
- **What:**
191+
- **Where:**
192+
- **When:**
193+
* Updating the value of a secret:
194+
- **Who:**
195+
- **What:**
196+
- **Where:**
197+
- **When:**
198+
199+
200+
The following GraphQL `Audit Event` types are available for secrets and you can find more details about them in the in the [GraphQL explorer](https://buildkite.com/docs/apis/graphql-api#getting-started).
201+
202+
```
203+
SECRET_CREATED
204+
SECRET_DELETED
205+
SECRET_QUERIED
206+
SECRET_READ
207+
SECRET_UPDATED
208+
```

0 commit comments

Comments
 (0)