Navigation updates and Ubuntu NBE requirements simplification #158
Conversation
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
- Implement comprehensive platform-first structure: Community, Cloud, Enterprise - Move NetBox Discovery and Assurance under Cloud and Enterprise platforms - Reorganize Administration sections with logical grouping (Getting Started, Management, Security) - Move Extensions to Community as NetBox Plugins - Duplicate Integrations across platforms for better discoverability - Align with DocHub integration strategy outlined in ai-reference/content-strategy/ This creates user-centric navigation that matches deployment types and improves content organization.
- Remove from Cloud and Enterprise sections - Add as final top-level navigation item - Aligns with request to make it a top-level item accessible to all users
- Create comprehensive Ubuntu requirements document (nbe-ec-requirements-ubuntu.md) - Add Ubuntu-specific system preparation steps including package installation, firewall configuration, kernel modules, and containerd setup - Include AppArmor configuration and troubleshooting sections - Update mkdocs.yml navigation to include Ubuntu requirements alongside RHEL - Add reference to Ubuntu requirements in main requirements document This provides Ubuntu users with complete guidance for preparing their systems for NetBox Enterprise installation.
- Streamline content to match concise RHEL document style - Remove repetitive information covered in main requirements - Focus on Ubuntu-specific commands and configurations - Maintain essential UFW firewall, apt, and AppArmor instructions - Reference main installation guide for complete process
- Add Kubernetes pod networking iptables rules discovered during testing - Include persistent iptables configuration with netfilter-persistent - Ensures proper pod-to-pod communication in Kubernetes cluster - Based on field testing feedback from Fred Mercer
- Consolidate firewall configuration into single section - Combine UFW and iptables commands for clarity - Add note explaining both are required (UFW for general firewall, iptables for pod networking) - Remove verbose explanations and comments - Maintain all Fred's tested iptables rules
- Check if UFW is already installed/enabled rather than forcing reinstall - Add comment that UFW rules are safe to run multiple times - More robust handling of existing firewall configurations
- Remove content duplication with main requirements doc - Focus only on Ubuntu-specific commands (UFW, apt, containerd setup) - Remove verbose explanations covered in main requirements - Keep all Fred's tested iptables rules in consolidated script - Reference main requirements doc for general concepts - Reduce from 130 to 50 lines (60% reduction)
- containerd is optional runtime, not required for NBE installation - Embedded cluster installer includes its own container runtime - Consistent with RHEL doc which lists containerd as 'optional runtime' - Focus only on essential Ubuntu-specific prerequisites - Reduce document to truly minimal requirements
- Separate required commands from optional UFW configuration - UFW is optional - not all Ubuntu systems use it - Required: swap, iptables pod networking, kernel modules - Optional: UFW firewall rules for those who use UFW - Clearer structure for different Ubuntu firewall configurations
- Add comment noting kernel modules are identical to RHEL requirements - Keep modules in Ubuntu doc for completeness and standalone usage - Acknowledge duplication while maintaining document usability - Ubuntu users can follow this doc without cross-referencing
- Add warning about UFW and direct iptables conflicts - Provide UFW-native pod networking rules using 'ufw route allow' - Clarify users should choose one approach, not both - Direct iptables approach in required section - UFW approach in optional section with equivalent rules - Prevent firewall configuration conflicts
rboucher-me
approved these changes
Jul 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🎯 Purpose
This PR implements navigation improvements and simplifies Ubuntu NBE prerequisites documentation.
🔧 Key Changes
Navigation Structure Updates
Ubuntu NBE Prerequisites Simplification
📁 Files Updated
🎉 Benefits
For Users
For Documentation Team
✅ Ready for Production
All changes maintain the existing navigation structure while adding requested improvements and comprehensive Ubuntu support for NetBox Enterprise installations.