paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 30 Packages Projects Releases Wiki Activity

chore: migrate audit events docs to docsite (#32143)

Browse Source 
* chore: migrate audit events docs to docsite

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* change headers

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix rebase conflict in sidebars.ts

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* correct sidebar

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
Aramis Sennyey
2026-01-22 08:45:06 -07:00
committed by GitHub
parent c1618d4085
commit 1e669ccd64
7 changed files with 93 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend/README.md
-29
View File
@@ -124,32 +124,3 @@ Default secrets are resolved from environment variables and accessible via `${{
```
**Security Note:** Secrets are automatically masked in logs and are only available to backend actions, never exposed to the frontend.
## Audit Events
The Scaffolder backend emits audit events for various operations. Events are grouped logically by `eventId`, with `subEventId` providing further distinction when needed.
**Template Events:**
- **`template-parameter-schema`**: Retrieves template parameter schemas. (GET `/v2/templates/:namespace/:kind/:name/parameter-schema`)
**Action Events:**
- **`action-fetch`**: Retrieves installed actions. (GET `/v2/actions`)
**Task Events:**
- **`task`**: Operations related to Scaffolder tasks.
Filter on `actionType`.
- **`create`**: Creates a new task. (POST `/v2/tasks`)
- **`list`**: Fetches details of all tasks. (GET `/v2/tasks`)
- **`get`**: Fetches details of a specific task. (GET `/v2/tasks/:taskId`)
- **`cancel`**: Cancels a running task. (POST `/v2/tasks/:taskId/cancel`)
- **`retry`**: Retries a failed task. (POST `/v2/tasks/:taskId/retry`)
- **`stream`**: Retrieves a stream of task logs. (GET `/v2/tasks/:taskId/eventstream`)
- **`events`**: Retrieves a snapshot of task logs. (GET `/v2/tasks/:taskId/events`)
- **`dry-run`**: Creates a dry-run task. (POST `/v2/dry-run`) All audit logs for events associated with dry runs have the `meta.isDryLog` flag set to `true`.
- **`stale-cancel`**: Automated cancellation of stale tasks.
- **`execute`**: Tracks the initiation and completion of a real scaffolder task execution. This event will not occur during dry runs.