DPF: Add critical DTS Grafana installation and production fixes - #117216
DPF: Add critical DTS Grafana installation and production fixes#117216szigmon wants to merge 2 commits into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
- Add complete Grafana installation with control-plane scheduling - Include comprehensive release notes and troubleshooting - Update Kubernetes version examples to v1.35.0 - Add AGE columns to verification outputs Fixes production-blocking issues: - Grafana 'Application is not available' error - Missing DTS observability installation instructions - Outdated version examples causing user confusion All YAML syntax validated with 'oc apply --dry-run=client'. Based on working production deployment.
📋 Changes Summary for ReviewersThis PR builds on the excellent DPF documentation from PR #117142 and adds only the critical missing pieces for production deployment success. 🎯 Our Specific Additions (5 files only):NEW FILES:
ENHANCED FILES:
|
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="nw-dpf-installing-grafana-for-dts_{context}"] | ||
| = Installing Grafana for DTS metrics visualization |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| [id="nw-dpf-release-notes_{context}"] | ||
| = Release notes and known issues |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
|
||
| == Known issues and limitations | ||
|
|
||
| === DPF uninstall support |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| * **Workaround**: Set `spec.manageDPUServiceTemplates: false` in the DPFHCPProvisionerConfig resource before uninstalling DPF | ||
| * **Impact**: Prevents the dpf-hcp-provisioner operator from managing DPUServiceTemplates during the uninstall process | ||
|
|
||
| === Secret references immutability |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| * **Solution**: Ensure secrets contain the correct data before creating and referencing them in the DPFHCPProvisioner CR | ||
| * **Impact**: Secret configuration errors require recreation of the entire DPFHCPProvisioner resource | ||
|
|
||
| === MTU configuration limitations |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| * **Solution**: Choose MTU value carefully during initial deployment - standard (1500) or jumbo frames (9000) | ||
| * **Impact**: MTU changes require complete cluster redeployment | ||
|
|
||
| === Secure boot requirements |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| * **Solution**: Use BFB firmware bundles to upgrade DPU firmware before deployment | ||
| * **Reference**: Consult NVIDIA DPU firmware update documentation | ||
|
|
||
| === Multi-DPU host limitations |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| * **Impact**: Only one BlueField-3 DPU can be provisioned per physical server | ||
| * **Workaround**: Use multiple single-DPU hosts for scale-out deployments | ||
|
|
||
| === HBN daemonset pod issues |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
|
|
||
| == Troubleshooting common issues | ||
|
|
||
| === Grafana "Application is not available" error |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| effect: NoSchedule | ||
| ---- | ||
|
|
||
| === Missing dashboards in Grafana |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| $ oc get clusterrolebinding grafana-prometheus-reader-cluster-monitoring | ||
| ---- | ||
|
|
||
| === DTS ServiceMonitor not finding services |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.NestedSection: Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.
| For additional support and troubleshooting resources: | ||
|
|
||
| * Consult the NVIDIA DPF documentation: link:https://docs.nvidia.com/networking/display/dpf2604/[] | ||
| * Review the OpenShift Container Platform documentation for networking operators |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
@szigmon: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
Closing this competing PR in favor of collaborative approach. All fixes and additions have been offered to the original author in PR #117142 for integration into their excellent work. This ensures proper credit and avoids duplicate effort while still addressing the critical production deployment gaps. Thank you to the OpenShift docs team for your guidance on collaborative contribution! 🤝 |
DPF: Add critical DTS Grafana installation and production fixes
🎯 Fixes Critical Production Issues in PR #117142
This PR addresses production-blocking gaps in the current DPF documentation that would prevent successful DTS observability deployment.
🚨 Issues Resolved
1. Missing Complete Grafana Installation
modules/nw-dpf-installing-grafana-for-dts.adocwith complete workflow2. Critical Control-Plane Scheduling Fix
3. Outdated Version Examples
4. Missing Release Notes & Troubleshooting
modules/nw-dpf-release-notes.adoc✅ Files Added/Modified
New Files
modules/nw-dpf-installing-grafana-for-dts.adoc- Complete Grafana installationmodules/nw-dpf-release-notes.adoc- Known issues and troubleshootingModified Files
networking/networking_operators/dpf_operator/dpf-validation-telemetry.adoc- Added Grafana installation section🧪 Testing Completed
All YAML resources validated:
🎯 Key Features Added
Complete Grafana Installation Workflow
Production-Critical Grafana CR Fix
Comprehensive Known Issues Documentation
💼 Production Impact
Before: Users cannot deploy DTS observability due to missing installation instructions
After: Complete, tested workflow for DTS observability deployment
Before: Grafana deployment fails with networking circular dependency
After: Grafana deploys successfully on control-plane nodes
Before: Confusion from outdated version examples
After: Current, accurate examples with realistic outputs
🔗 References
📋 Checklist
Priority: High - Resolves production-blocking documentation gaps
Impact: Enables successful DTS observability deployment in enterprise environments