Skip to content

docs(doc-1415): add logging overview and cross-links in vcluster folder#2134

Open
djwfyi wants to merge 3 commits into
mainfrom
doc-1415/vcluster-logging-crosslinks
Open

docs(doc-1415): add logging overview and cross-links in vcluster folder#2134
djwfyi wants to merge 3 commits into
mainfrom
doc-1415/vcluster-logging-crosslinks

Conversation

@djwfyi
Copy link
Copy Markdown
Collaborator

@djwfyi djwfyi commented May 15, 2026

Content Description

Adds a new vcluster/manage/logging.mdx overview page explaining the three types of logs vCluster produces (control plane logs, audit logs, workload logs), with real log output examples and tabbed HostPath Mapper options for vCluster OSS vs vCluster Platform. Also adds targeted cross-links in logging.mdx, ingress-access.mdx, and the CIS hardening guide.

Preview Link

Internal Reference

Closes DOC-1415

Note: this PR must merge after #2133, which adds the platform-side logging section this PR cross-links to.

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

djwfyi and others added 3 commits May 15, 2026 17:00
…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>
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>
- manage/logging.mdx: new overview page covering control plane logs, audit
  logs, and workload logs with log examples; HostPath Mapper options tabbed
  between vCluster OSS and vCluster Platform
- configure/vcluster-yaml/logging.mdx: add debug logging section linking to how-to
- key-features/ingress-access.mdx: link audit mention to platform audit page
- deploy/.../3-control-plane.mdx: add platform audit tip and --audit-log-path example

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:51
@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 073705f
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6a079565f0e37c0008e3494e
😎 Deploy Preview https://deploy-preview-2134--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.

@github-actions
Copy link
Copy Markdown
Contributor

@djwfyi djwfyi self-assigned this May 15, 2026
@djwfyi djwfyi added the backport-v0.34 Backport this PR to the v0.34 versioned docs label May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-v0.34 Backport this PR to the v0.34 versioned docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant