HDDS-9857. Migrate core concepts documentation #149
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
github-actions
bot
added
the
website-v2
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the core concepts documentation from the legacy site into the new docs structure, replaces stub pages with full content, and reorganizes categories for consistency.
- Corrected category file syntax and removed legacy stub folders
- Deleted placeholder TODO pages and introduced complete docs for architecture, namespace, security, and data-replication
- Added detailed content for write pipelines, security (Kerberos, ACLs, Ranger), encryption, bucket layouts, and container concepts
Reviewed Changes
Copilot reviewed 55 out of 82 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/03-core-concepts/category.yml | Fixed YAML frontmatter syntax for the Core Concepts category |
| docs/03-core-concepts/01-architecture.md | Added full Architecture overview |
| docs/03-core-concepts/02-data-replication/02-write-pipelines.md | Introduced comprehensive Write Pipelines documentation |
| docs/03-core-concepts/04-security/02-acls/02-ranger-acls.md | Added detailed Ranger ACL integration guide |
| docs/03-core-concepts/05-configuration-files.md | Removed placeholder stub |
Comments suppressed due to low confidence (3)
docs/03-core-concepts/04-security/00-overview.mdx:1
- [nitpick] The MDX file lacks frontmatter for
sidebar_label. Adding a YAML frontmatter block (e.g.,---\nsidebar_label: Overview\n---) ensures consistent sidebar labeling.
# Security Overview
kerneltime
changed the title
Contributor
|
@kerneltime please resolve conflicts |
jojochuang
added a commit
to kerneltime/ozone-site
that referenced
this pull request
Jul 26, 2025
This commit addresses various CI test failures identified in pull request apache#149. The following issues have been resolved: - Markdown linting errors: Corrected capitalization, list formatting, and blank line issues in several documentation files. - Sidebar configuration errors: Added missing files with appropriate frontmatter (sidebar_label, sidebar_position, DocCardList import/tag) to ensure correct sidebar generation. - YAML linting: Manually verified YAML files for correct syntax, as automated linting was unavailable. These changes aim to bring the documentation in line with project standards and pass CI checks.
- Added SVG icons for namespace, volumes, buckets, and security pages - Created filesystem-vs-keys.svg comparing traditional files to objects - Updated replication.svg with clearer visual elements - Resized Ranger logo for better visibility on ACL page - Fixed layouts for better icon sizing and spacing on all pages
- Moved namespace documentation from position 03 to 01 in core concepts - Renamed replication section to data-replication for better clarity - Added new README.mdx for data-replication section - Removed separate ratis and erasure-coding docs (will be integrated elsewhere) - Updated architecture documentation and overview
- Document common web UI features across all components - Add component-specific web UI information with default ports - Include configuration properties for changing web UI ports - Document security options for web UIs - Provide troubleshooting guidance and best practices
- Document common web UI features across all components - Add component-specific web UI information with default ports - Include configuration properties for changing web UI ports - Document security options for web UIs - Provide troubleshooting guidance and best practices - Fix XML property name tags
- Update HTTPS port from 19878 to 9879 based on source code - Add Web Admin UI ports (19878/19879) - Add configuration for Web Admin UI ports
- Update configuration properties to use httpfs.http.port instead of ozone.httpfs.http-address - Remove HTTPS port as it uses httpfs.ssl.enabled to enable HTTPS on the same port - Add configuration for enabling SSL
- Add S3 security section with credential management details - Add Kerberos authentication requirements for S3 credentials - Fix build issue by replacing CardLayout with standard React components
- Provide detailed component architecture overview - Include hardware recommendations for all service types - Document consolidated vs. dedicated node deployment patterns - Add detailed network design considerations - Include specific deployment examples for different scales - Provide load balancer configuration guidance
- Refactor deployment architecture to focus on patterns and topology - Create comprehensive hardware-and-sizing guide with detailed specifications - Add reference configurations for different scales of deployment - Include load balancer and multi-datacenter deployment guidelines - Incorporate Cloudera recommendations for enterprise deployments
- Clarify that Ozone can run on a single node for development/testing - Note that hardware specifications reflect production deployments - Emphasize that hardware choice depends on scale and performance needs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What changes were proposed in this pull request?
This migration includes comprehensive documentation for:
The content has been reorganized to follow the new site structure and all internal links have been updated to work with the new paths.
Generated-by: Claude and Gemini
What is the link to the Apache Jira?
HDDS-9857
How was this patch tested?
Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.