Myrescue#2
Open
newgoliath wants to merge 45 commits intoRedHatQuickCourses:mainfrom
Open
Conversation
Major content reorganization to streamline the troubleshooting workshop from 10 modules to 8 modules, with focus on core tools and workflows. Content Changes: - Module 3: Replaced vSphere IPI troubleshooting scenario with OpenShift Insights/Lightspeed proactive cluster analysis using ocp_insights.py - Module 5: Consolidated etcd performance analysis, moved content from former Module 6, now using etcd-ocp-diag.py for log analysis - Module 1: Removed koff tool documentation and references - Modules 6-8: Placeholder content for upcoming OVN Lab modules Deleted Modules: - Module 6: Analyzing etcd Performance (merged into Module 5) - Module 7: Reviewing Cluster Upgrades - Module 8: Reviewing Installed Operators - Module 9: OCP networking - Traffic distribution issues - Module 10: Exploring etcd snapshots with koff Tool Updates: - Updated script references from shell (.sh) to Python (.py) implementations - Removed koff tool from the workshop entirely - Focus on omc, kubectl-dev_tool, ocp_insights.py, and etcd-ocp-diag.py Files Modified: - content/modules/ROOT/nav.adoc - content/modules/ROOT/pages/index.adoc - content/modules/ROOT/pages/module-01.adoc - content/modules/ROOT/pages/module-03.adoc - content/modules/ROOT/pages/module-05.adoc Files Deleted: - content/modules/ROOT/pages/module-06.adoc - content/modules/ROOT/pages/module-07.adoc - content/modules/ROOT/pages/module-08.adoc - content/modules/ROOT/pages/module-09.adoc - content/modules/ROOT/pages/module-10.adoc
Updates year references and significantly enhances Module 01 with comprehensive tool descriptions, use cases, and practical examples. Index Page Updates (index.adoc): - Updated event year from 'Red Hat One 2025' to 'Red Hat One 2026' - Corrected lab module count from 10 to 8 (reflecting recent restructure) - Refined Module 3 description: 'proactively look for performance issues' → 'triage an OpenShift Cluster' (more accurate scope) Module 01 Enhancements (module-01.adoc): Expanded all tool introductions from brief one-liners to detailed descriptions with practical examples and use cases: omc: - Added comprehensive description of OpenShift Must-Gather Client - Updated documentation link from 4.17 to 4.19 kubectl-dev_tool: - Expanded from one line to detailed functionality overview - Clarified audit log filtering capabilities (user, resource, verb) - Updated documentation link from 4.17 to 4.19 yq and jq: - Added detailed explanations of JSON/YAML processing - Included practical code examples showing output differences - Demonstrated usage with node status conditions gron: - Expanded with comprehensive JSON flattening explanation - Added practical example: discovering JSON paths for scripting - Included bash for-loop example iterating over worker nodes etcd-ocp-diag: - Enhanced description of etcd performance error detection - Clarified statistics and timeline analysis capabilities ocp_insights: - Renamed from 'Insights Operator' to 'OpenShift LightSpeed' (current branding) - Added context about proactive analysis and data collection - Expanded description of cluster triaging capabilities Documentation Quality Improvements: - Added 93 lines of new content with code examples - Improved technical accuracy and specificity - Enhanced readability for lab participants - Updated all documentation links to OpenShift 4.19
Update lab title across configuration files to reflect expanded scope and
advanced troubleshooting focus for Red Hat One 2026.
Changes:
- content/antora.yml:
* Updated title: 'Anatomy of a must-gather - Analyzing real customer issues'
→ 'Beyond the Basics - Advanced OpenShift Troubleshooting Techniques'
* Updated lab_name attribute to match new branding
- default-site.yml:
* Updated site title: 'Anatomy of a Must-Gather Lab'
→ 'Beyond the Basics - Advanced OpenShift Troubleshooting Techniques'
Simplify workshop content by removing gron tool, correcting Module 03 file references, and improving Module 04 readability. Changes to content/modules/ROOT/nav.adoc: - Removed navigation link to gron tool section Changes to content/modules/ROOT/pages/module-01.adoc: - Removed complete gron tool section (~24 lines) * Deleted tool description and use case explanation * Removed practical example showing JSON path discovery * Removed bash for-loop example for worker node iteration * Deleted GitHub download link Rationale for removing gron: The gron tool, while useful, adds complexity for participants who can achieve similar results using jq directly. Removing it streamlines the workshop to focus on core must-gather analysis tools that are more commonly used in production support scenarios. Changes to content/modules/ROOT/pages/module-03.adoc: - Fixed directory reference: ~/Module5/ → ~/Module3/ - Corrected data file references throughout (6 instances): * module5-insights-data → Module3-insights-data - Ensures consistency with module numbering after restructure - Fixes copy-paste errors from previous module consolidation Module 03 path corrections: These fixes ensure all commands and examples reference the correct module directory and data files. The previous references to Module5 were remnants from when this content was moved during the earlier restructure. Changes to content/modules/ROOT/pages/module-04.adoc: - Removed all collapsible hint sections (6 instances) - Improved presentation flow by showing content directly - Fixed trailing whitespace issues throughout file - Made content more linear and easier to follow Module 04 improvements: The collapsible hints interrupted the learning flow. By presenting the information directly, participants can follow along more naturally without clicking to reveal content. This aligns better with a hands-on lab format where all information should be readily accessible.
- Add disclaimer about community tools and Red Hat support - Restructure kubectl-dev_tool section with Installation and Usage headers - Update kubectl-dev_tool installation from 'go install' to 'go get' - Add Installation section for jq/yq with package manager example - Add Usage section headers to improve documentation organization
Module 4 is now 'Analyzing etcd Performance' (etcd-ocp-diag.py) Module 5 is now 'What is overloading my API?' (kubectl-dev_tool audit) This reordering provides a more logical flow through the troubleshooting material by covering etcd performance issues before diving into API overload analysis. Changes: - Update navigation links and section references - Swap complete content between module-04.adoc and module-05.adoc - Update module descriptions in index.adoc
Fix module numbering in navigation after module swap: - Module 4: Analyzing etcd Performance (was labeled as 5) - Module 5: What is overloading my API? (was labeled as 4) Add three new OVN troubleshooting modules: - Module 6: OVN Lab Module 1 - Module 7: OVN Lab Module 2 - Module 8: OVN Lab Module 3 Files added: - module-06.adoc (placeholder) - module-07.adoc (placeholder) - module-08.adoc (placeholder) Navigation structure now includes all 8 modules with correct sequential numbering.
Create ui-config.yml to configure Nookbag UI
- Update omc version from v3.7.4 to v3.12.2 - Refresh all command outputs with OCP 4.18.0 nightly cluster - Update etcd version from 3.5.13 to 3.5.18 - Add new examples for firing and pending Prometheus alerts - Enhance output examples with additional fields and details - Minor formatting improvements for better readability
- Add missing closing backtick after Status on line 143 - Change 'indicated' to 'indicates' for correct verb tense - Fix subject-verb agreement: 'capture' to 'captures' (2 instances) - Correct section title from 'Install Plans' to 'Installed OLM Operators' - Fix typos: 'customer' to 'customers', 'namesapces' to 'namespaces' - Fix typo: 'containe restarts' to 'on container restarts' - Improve grammar: 'alerts on firing' to 'alerts that are firing' - Fix missing verb: 'it helpful' to 'it is helpful' - Fix typo: 'failured' to 'failed'
Replace absolute paths (~/Module3/, ../Module3/) with relative paths (./) to improve portability and consistency across all code examples. Changes: - cd ~/Module3/ → cd ./ - ~/Module3/Cluster_X/ → ./Cluster_X/ - ../Module3/Cluster_X/ → ./Cluster_X/ This affects 15 instances across all command examples in the module.
…tion - Reorganize Module 3 navigation with detailed subsections - Add three hands-on lab scenarios to Module 3 (cluster operators, authentication, etcd issues) - Restructure Module 4 content flow (move Common Errors before Stats section) - Update Module 4 help output with new flags (--lost_leader, --overloaded, -i) - Add three etcd troubleshooting lab scenarios to Module 4 - Update examples with more realistic cluster data and detailed error output - Fix file paths and improve command examples throughout
- Module 2: Add note about HAProxy backends not being in example must-gather - Module 3: Update cluster operators description to include Reason field - Module 3: Fix wording in Scenario 1 for better clarity - Module 4: Improve formatting by removing unnecessary numbered list - Module 4: Update command examples with correct must-gather paths - Module 4: Add --election command example with output - Module 4: Remove unnecessary shell prompt from command example
- Remove extra space in 'LIST commands' - Fix grammar: 'take to data' -> 'take the data' - Clean up trailing whitespace
- Update omc use command to reference must-gather.local in module-02 - Add grep filter to ocp_insights.py output in module-03 for better readability
- Correct directory path from module4/ to Module4/
- Add additional etcd-ocp-diag.py command examples in module-04 - Improve output formatting in module-04 examples - Fix grammar in module-05 TIP section (Can you -> You can) - Correct directory case from module5 to Module5 in module-05
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.