Skip to content

docs(doc-1415): add maintenance/logging section#2133

Open
djwfyi wants to merge 2 commits into
mainfrom
doc-1415/maintenance-logging-section
Open

docs(doc-1415): add maintenance/logging section#2133
djwfyi wants to merge 2 commits into
mainfrom
doc-1415/maintenance-logging-section

Conversation

@djwfyi
Copy link
Copy Markdown
Collaborator

@djwfyi djwfyi commented May 15, 2026

Content Description

Creates a new platform/maintenance/logging/ section as a sibling to monitoring. This addresses DOC-1415 (customer confusion between platform audit logs and tenant cluster audit logs) by providing a unified entry point that distinguishes all three platform logging types and links to the correct configuration page for each.

New pages:

  • overview.mdx — explains platform audit logs, platform process logs, and workload logs; includes per-level audit breakdown table (with excluded and sensitive resources sourced from code), log level comparison table, and HostPath Mapper deployment options
  • platform-logging.mdx — how to configure log level and output format for the platform pod, extracted from metrics.mdx

metrics.mdx is trimmed to metrics only, with a callout linking to the new logging section. monitoring/overview.mdx is updated to point to the new section for platform process log configuration.

Preview Link

Adds a new Maintenance/Logging section with:

Modifies an existing configure/audit page:

Internal Reference

Closes DOC-1415

AI review: mention @claude in a comment to request a review or changes. See CONTRIBUTING.md for available commands.

FORK LIMITATION: @claude does not work on pull requests opened from forks. GitHub Actions cannot access the required secrets for fork-originated PRs. To use AI review, push your branch directly to this repository.

@netlify /docs

…s log overview

Create platform/maintenance/logging/ as a new section alongside monitoring.
Add overview.mdx explaining all three platform logging types (audit logs,
process logs, workload logs) with per-level audit breakdown table and
HostPath Mapper deployment options. Add platform-logging.mdx covering
log level and format configuration, extracted from metrics.mdx.

Trim metrics.mdx to metrics only and add a callout linking to the new
logging section. Update monitoring/overview.mdx to point to logging
section for platform process log configuration.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@djwfyi djwfyi requested a review from a team as a code owner May 15, 2026 21:01
@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit ba7d547
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6a078c08469fe3000846e40d
😎 Deploy Preview https://deploy-preview-2133--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@djwfyi djwfyi self-assigned this May 15, 2026
@djwfyi djwfyi added the backport-v4.9.0 Backport this PR to the v4.9.0 versioned docs label May 15, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Consolidate three repeated audit/config.audit warnings into one clear
Info callout at the top of Enable auditing. Replace prose restart notice
with a Warning admonition. Remove pinned Helm version 4.0.0-alpha.12 from
PVC and sidecar commands. Simplify the two secondary notes to brief
references back to the main explanation.

Add audit logging reference to monitoring/overview.mdx Log collection
section so users find the Logging section from the monitoring page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-v4.9.0 Backport this PR to the v4.9.0 versioned docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant