Skip to content

docs: document the Auditor role and the audit log exporter - #675

Open
utkuozdemir wants to merge 1 commit into
siderolabs:mainfrom
utkuozdemir:docs/omni-auditor-role
Open

docs: document the Auditor role and the audit log exporter#675
utkuozdemir wants to merge 1 commit into
siderolabs:mainfrom
utkuozdemir:docs/omni-auditor-role

Conversation

@utkuozdemir

@utkuozdemir utkuozdemir commented Jul 28, 2026

Copy link
Copy Markdown
Member

Omni has a new Auditor role that grants read access plus the audit log and nothing else, so reading the audit log no longer requires Admin. Access is granted by exact role rather than by seniority, so Operator does not get it despite being more privileged, and the role cannot be assigned by an access policy or a SAML label rule.

A new page covers the audit log exporter: how to run it, where an export starts, how it resumes across restarts, and what stops it rather than being retried. The existing audit log page said Omni had no built-in way to export, so it now points at the new page instead. The event reference also drops two fields that no longer exist and gains the resource id and the audit log access event type.

The agent guide is corrected while here. It described the navigation as being edited directly in the generated file rather than in the per-product configs it is built from, and it now also lists the checks CI runs so they can be run before pushing.

Draft until the Auditor role lands in Omni and ships in a release, since the docs site publishes continuously and would otherwise describe a role that cannot be selected yet.

Part of siderolabs/omni#2985.

@utkuozdemir
utkuozdemir force-pushed the docs/omni-auditor-role branch from 682a375 to d633dca Compare July 28, 2026 16:53
@utkuozdemir utkuozdemir changed the title docs: document the Auditor role docs: document the Auditor role and the audit log exporter Jul 28, 2026
@utkuozdemir
utkuozdemir requested a review from Iheanacho-ai July 28, 2026 16:55
@utkuozdemir
utkuozdemir force-pushed the docs/omni-auditor-role branch 2 times, most recently from b4dcef2 to 6653567 Compare July 28, 2026 17:07
@utkuozdemir

Copy link
Copy Markdown
Member Author

@Iheanacho-ai Let's keep this not merged until we release Omni 1.10.0.

@utkuozdemir
utkuozdemir marked this pull request as ready for review July 28, 2026 17:09
@github-project-automation github-project-automation Bot moved this to To Do in Planning Jul 28, 2026
@talos-bot talos-bot moved this from To Do to In Review in Planning Jul 28, 2026
Comment thread public/omni/cluster-management/export-audit-logs.mdx Outdated
Comment thread public/omni/cluster-management/export-audit-logs.mdx Outdated
Comment thread public/omni/cluster-management/export-audit-logs.mdx Outdated
@Iheanacho-ai

Iheanacho-ai commented Jul 29, 2026

Copy link
Copy Markdown
Member

The hierachy of your doc is off. This is a better hierachy:

  • Introduction
  • Prerequisites
  • Set up the exporter (parent for the actual procedure)
    • Step 1: Create a service account
    • Step 2: Run the exporter
  • Configure behavior (parent for the tuning topics)
    • Choose where the export starts
    • Resume across restarts
  • Understand the delivery guarantees
  • Troubleshoot

Omni has a new Auditor role that grants read access plus the audit log and nothing else, so reading the audit log no longer requires Admin. Access is granted by exact role rather than by seniority, so Operator does not get it despite being more privileged, and the role cannot be assigned by an access policy or a SAML label rule.

A new page covers the audit log exporter: how to run it, where an export starts, how it resumes across restarts, and what stops it rather than being retried. The existing audit log page said Omni had no built-in way to export, so it now points at the new page instead. The event reference also drops two fields that no longer exist and gains the resource id and the audit log access event type.

The agent guide is corrected while here. It described the navigation as being edited directly in the generated file rather than in the per-product configs it is built from, and it now also lists the checks CI runs so they can be run before pushing.

Part of siderolabs/omni#2985.

Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
@utkuozdemir
utkuozdemir force-pushed the docs/omni-auditor-role branch from 6653567 to f37d331 Compare August 3, 2026 08:58
@utkuozdemir

Copy link
Copy Markdown
Member Author

The hierachy of your doc is off. This is a better hierachy:

  • Introduction

  • Prerequisites

  • Set up the exporter (parent for the actual procedure)

    • Step 1: Create a service account
    • Step 2: Run the exporter
  • Configure behavior (parent for the tuning topics)

    • Choose where the export starts
    • Resume across restarts
  • Understand the delivery guarantees

  • Troubleshoot

reworked as you suggested

@smira smira moved this from In Review to Approved in Planning Aug 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Approved

Development

Successfully merging this pull request may close these issues.

4 participants