Skip to content

Commit 0cbe1e2

Browse files
committed
Fix headings in ceph.md
Correct the heading levels in ceph.md. Signed-off-by: Zac Dover <zac.dover@clyso.com>
1 parent 60475a7 commit 0cbe1e2

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

docs/architecture/ceph.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ each other to replicate and redistribute data dynamically.
1414

1515
## Architecture
1616

17-
## Ceph Block Device Summary (RBD)
17+
### Ceph Block Device Summary (RBD)
1818

19-
### Overview of RBD
19+
#### Overview of RBD
2020

2121
A block is a sequence of bytes, often 512 bytes in size. Block-based storage
2222
interfaces represent a mature and common method for storing data on various
@@ -25,7 +25,7 @@ compact discs (CDs), floppy disks, and magnetic tape. The widespread adoption
2525
of block device interfaces makes them an ideal fit for mass data storage
2626
applications, including their integration with Ceph storage systems.
2727

28-
### Core Features
28+
#### Core Features
2929

3030
Ceph block devices are designed with three fundamental characteristics:
3131
thin-provisioning, resizability, and data striping across multiple Object
@@ -41,7 +41,7 @@ page caching for performance optimization. For applications that rely on the
4141
librbd library, Ceph provides its own RBD (RADOS Block Device) caching
4242
mechanism to enhance performance.
4343

44-
### Performance and Scalability
44+
#### Performance and Scalability
4545

4646
Ceph's block devices are engineered to deliver high performance combined with
4747
vast scalability capabilities. This performance extends to various deployment
@@ -56,7 +56,7 @@ libvirt and QEMU technologies. This integration allows these cloud platforms to
5656
leverage Ceph's distributed storage capabilities for their virtual machine
5757
storage requirements.
5858

59-
### Unified Storage Cluster
59+
#### Unified Storage Cluster
6060

6161
One of Ceph's significant architectural advantages is its ability to support
6262
multiple storage interfaces simultaneously within a single cluster. The same
@@ -74,7 +74,7 @@ types within one cluster provides operational efficiency and cost-effectiveness
7474
while maintaining the performance and reliability characteristics required for
7575
enterprise deployments.
7676

77-
### Technical Implementation
77+
#### Technical Implementation
7878

7979
The thin-provisioning feature of Ceph block devices means that storage space is
8080
allocated only as data is written, rather than pre-allocating the entire volume
@@ -98,7 +98,7 @@ distributed according to the cluster's CRUSH (Controlled Scalable Decentralized
9898
Placement of Replicated Data) algorithm, which determines optimal placement
9999
based on cluster topology and configured policies.
100100

101-
### RADOS Integration
101+
#### RADOS Integration
102102

103103
The integration with RADOS provides Ceph block devices with enterprise-grade
104104
features. Snapshotting capability enables point-in-time copies of block devices,
@@ -120,7 +120,7 @@ librbd allows applications to interact with Ceph block devices programmatically,
120120
supporting a wide range of use cases from bare-metal servers to containerized
121121
applications.
122122

123-
### Conclusion
123+
#### Conclusion
124124

125125
Ceph block devices represent a sophisticated implementation of block storage
126126
that combines the traditional simplicity of block-based interfaces with modern
@@ -136,9 +136,9 @@ single infrastructure platform. This convergence of capabilities, combined with
136136
proven integration with major virtualization and cloud platforms, establishes
137137
Ceph block devices as a viable solution for modern data center storage needs.
138138

139-
## RADOS Gateway (RGW) in Summary
139+
### RADOS Gateway (RGW) in Summary
140140

141-
### Introduction
141+
#### Introduction
142142

143143
RADOS Gateway, commonly referred to as RGW or radosgw, is Ceph's object storage
144144
interface that provides applications with a RESTful gateway to store objects
@@ -150,7 +150,7 @@ cloud storage solutions that are compatible with industry-standard APIs while
150150
leveraging Ceph's distributed architecture for reliability, scalability, and
151151
performance.
152152

153-
### Architecture and Design
153+
#### Architecture and Design
154154

155155
RGW operates as a FastCGI or standalone HTTP service that sits atop the Ceph
156156
Storage Cluster. Unlike direct RADOS access, RGW provides a higher-level
@@ -167,7 +167,7 @@ S3/Swift objects and the underlying RADOS objects. This abstraction layer allows
167167
a single S3 or Swift object to potentially map to multiple RADOS objects,
168168
particularly for large files that are striped across the cluster.
169169

170-
### API Compatibility
170+
#### API Compatibility
171171

172172
One of RGW's most significant features is its dual API compatibility. RGW
173173
provides RESTful interfaces compatible with both Amazon S3 and OpenStack Swift,
@@ -185,7 +185,7 @@ namespace, meaning data written through the S3 API can be read through the Swift
185185
API and vice versa, providing exceptional flexibility for multi-application
186186
environments.
187187

188-
### Multi-Tenancy and User Management
188+
#### Multi-Tenancy and User Management
189189

190190
RGW implements sophisticated multi-tenancy capabilities that allow multiple
191191
independent users and organizations to share the same Ceph cluster while
@@ -200,7 +200,7 @@ quotas, and usage statistics independently, enabling service providers to offer
200200
object storage as a multi-tenant service with per-user billing and resource
201201
limits.
202202

203-
### Data Organization
203+
#### Data Organization
204204

205205
RGW organizes data using a bucket-based model for S3 compatibility (containers
206206
in Swift terminology). Buckets are logical containers that hold objects, with
@@ -215,7 +215,7 @@ strategies to different data types. For example, bucket indexes might use
215215
replication for fast access while large data objects use erasure coding for
216216
storage efficiency.
217217

218-
### Advanced Features
218+
#### Advanced Features
219219

220220
RGW supports numerous advanced object storage features that make it suitable for
221221
production deployments. Object versioning allows multiple versions of the same
@@ -231,7 +231,7 @@ directly from browsers. Bucket notifications allow applications to receive
231231
real-time events when objects are created, deleted, or modified, enabling
232232
event-driven architectures.
233233

234-
### Scalability and Performance
234+
#### Scalability and Performance
235235

236236
RGW's architecture enables horizontal scaling to meet growing storage and
237237
throughput demands. Multiple RGW instances can be deployed behind load
@@ -247,7 +247,7 @@ The gateway also supports byte-range requests, enabling efficient partial
247247
object retrieval for large files and supporting features like HTTP video
248248
streaming.
249249

250-
### Multi-Site Capabilities
250+
#### Multi-Site Capabilities
251251

252252
RGW includes robust multi-site replication capabilities for disaster recovery,
253253
geographic distribution, and compliance requirements. The multi-site
@@ -263,7 +263,7 @@ consistent configuration states across all zones. This sophisticated
263263
replication framework supports complex scenarios like hub-and-spoke topologies,
264264
full-mesh replication, and tiered storage architectures.
265265

266-
### Monitoring and Operations
266+
#### Monitoring and Operations
267267

268268
RGW provides comprehensive monitoring capabilities through usage statistics,
269269
performance metrics, and administrative APIs. Administrators can track
@@ -276,7 +276,7 @@ facilitating automation and integration with billing systems or custom
276276
management tools. Command-line tools provide capabilities for troubleshooting,
277277
data inspection, and emergency operations.
278278

279-
### Conclusion
279+
#### Conclusion
280280

281281
RADOS Gateway represents a mature, feature-rich object storage solution that
282282
brings cloud-compatible APIs to Ceph's distributed storage platform. By
@@ -289,9 +289,9 @@ part of the unified Ceph storage platform, RGW benefits from the same
289289
reliability, performance, and operational characteristics that make Ceph a
290290
leading choice for software-defined storage solutions.
291291

292-
## CephFS in Summary
292+
### CephFS in Summary
293293

294-
### Introduction
294+
#### Introduction
295295

296296
CephFS (Ceph File System) is Ceph's distributed file system interface that
297297
provides POSIX-compliant file storage built on top of the RADOS object store.
@@ -304,7 +304,7 @@ storage features makes CephFS suitable for workloads ranging from home
304304
directories and shared application data to high-performance computing and big
305305
data analytics.
306306

307-
### Architecture and Components
307+
#### Architecture and Components
308308

309309
CephFS operates through a carefully designed architecture that separates data
310310
and metadata management. At its core, CephFS relies on two essential components:
@@ -326,7 +326,7 @@ enabling parallel I/O and leveraging the aggregate bandwidth of multiple storage
326326
devices. This architecture allows CephFS to scale from gigabytes to petabytes
327327
while maintaining consistent performance characteristics.
328328

329-
### POSIX Compliance and Compatibility
329+
#### POSIX Compliance and Compatibility
330330

331331
CephFS provides strong POSIX compliance, supporting the vast majority of
332332
standard filesystem operations expected by applications and users. This includes
@@ -344,7 +344,7 @@ requiring non-root access. Additionally, libcephfs provides a library interface
344344
for applications to interact with CephFS programmatically, enabling custom
345345
integration scenarios.
346346

347-
### Metadata Server Design
347+
#### Metadata Server Design
348348

349349
The MDS represents a sophisticated component designed specifically for
350350
distributed metadata management. In CephFS, metadata operations like listing
@@ -369,7 +369,7 @@ sharded across multiple MDS daemons, with each daemon handling different entries
369369
within the same directory. This dynamic load balancing ensures that metadata
370370
operations scale with the number of active MDS instances.
371371

372-
### Performance Characteristics
372+
#### Performance Characteristics
373373

374374
CephFS delivers strong performance across diverse workloads through several
375375
architectural optimizations. Client-side caching reduces latency for frequently
@@ -390,7 +390,7 @@ MDS cache provides excellent performance. The ability to scale metadata
390390
operations through multiple active MDS daemons addresses the metadata bottleneck
391391
that plagues many distributed filesystems at scale.
392392

393-
### Snapshots and Quotas
393+
#### Snapshots and Quotas
394394

395395
CephFS provides sophisticated snapshot capabilities enabling point-in-time
396396
copies of directory trees. Snapshots are space-efficient, storing only changed
@@ -407,7 +407,7 @@ and the number of files, with enforcement occurring at write time. This enables
407407
multi-tenant deployments where different users or projects share a filesystem
408408
while preventing any single entity from consuming excessive resources.
409409

410-
### Multiple Filesystems
410+
#### Multiple Filesystems
411411

412412
Recent CephFS versions support multiple independent filesystems within a single
413413
Ceph cluster, each with its own namespace, MDS cluster, and data pools. This
@@ -416,7 +416,7 @@ sharing the underlying storage infrastructure. Each filesystem can be configured
416416
with different parameters, replication strategies, or performance
417417
characteristics appropriate to its specific workload requirements.
418418

419-
### Security and Access Control
419+
#### Security and Access Control
420420

421421
CephFS implements multiple layers of security. Path-based access restrictions
422422
allow administrators to limit client access to specific directory subtrees,
@@ -430,7 +430,7 @@ file and directory level, allowing familiar Unix-style permission management.
430430
Extended attributes enable additional metadata storage for applications
431431
requiring custom attributes or security labels.
432432

433-
### Use Cases and Applications
433+
#### Use Cases and Applications
434434

435435
CephFS excels in scenarios requiring shared filesystem access across multiple
436436
clients. Home directories, shared application data, and collaborative workspaces
@@ -444,7 +444,7 @@ scale capacity and performance independently. Big data analytics platforms use
444444
CephFS for storing datasets that multiple processing nodes must access
445445
simultaneously.
446446

447-
### Conclusion
447+
#### Conclusion
448448

449449
CephFS represents a mature, scalable distributed filesystem that brings POSIX
450450
compatibility to Ceph's distributed storage platform. By separating metadata and

0 commit comments

Comments
 (0)