This is an automated email from the ASF dual-hosted git repository.
weichiu pushed a commit to branch HDDS-9225-website-v2
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/HDDS-9225-website-v2 by this
push:
new 2a9f15005 HDDS-14285. [Website v2] [Docs] [Core Concepts] Buckets
Overview (#207)
2a9f15005 is described below
commit 2a9f15005aab98d08e7c3cc04d80ea3aa53a9da9
Author: Eric C. Ho <[email protected]>
AuthorDate: Sun Jan 4 14:55:26 2026 +0800
HDDS-14285. [Website v2] [Docs] [Core Concepts] Buckets Overview (#207)
---
cspell.yaml | 1 +
.../03-namespace/02-buckets/01-overview.md | 57 +++++++++++++++++++++-
.../03-namespace/02-buckets/03-quotas.md | 5 +-
.../03-namespace/02-buckets/06-encryption.md | 6 ++-
.../03-namespace/02-buckets/08-snapshots.md | 14 ++++++
5 files changed, 80 insertions(+), 3 deletions(-)
diff --git a/cspell.yaml b/cspell.yaml
index edbecd26a..789859e72 100644
--- a/cspell.yaml
+++ b/cspell.yaml
@@ -89,6 +89,7 @@ words:
- EC
- quasi-close
- quasi-closed
+- HCFS
# Other systems' words
- KDC
- classpath
diff --git a/docs/03-core-concepts/03-namespace/02-buckets/01-overview.md
b/docs/03-core-concepts/03-namespace/02-buckets/01-overview.md
index e50ab7c44..422136d91 100644
--- a/docs/03-core-concepts/03-namespace/02-buckets/01-overview.md
+++ b/docs/03-core-concepts/03-namespace/02-buckets/01-overview.md
@@ -4,4 +4,59 @@ sidebar_label: Overview
# Buckets Overview
-**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
+## What is a Bucket?
+
+A **Bucket** is the second level in the Ozone data hierarchy, residing within
a volume. Buckets are analogous to directories or folders in a traditional file
system.
+They serve as containers for keys (data objects).
+
+**Key Characteristics:**
+
+- **Contained within Volumes:** Every bucket must belong to a volume.
+- **Container for Keys:** A bucket can contain any number of keys.
+- **No Nested Buckets:** Unlike directories, buckets cannot contain other
buckets.
+
+## Details
+
+### Creation and Management
+
+Buckets are created within a specified volume.
+
+```bash
+ozone sh bucket create /myvolume/mybucket
+```
+
+For more details on bucket operations, refer to the [Ozone CLI
documentation](../../../04-user-guide/01-client-interfaces/01-o3.md#bucket-operations).
+
+### Bucket Layouts (Object Store vs. File System Optimized)
+
+Ozone supports different bucket layouts, primarily:
+
+- **Object Store (OBS):** The traditional object storage layout, where keys
are stored with their full path names. This is suitable for S3-like access
patterns.
+For more details, refer to the [Object Store
documentation](./04-layouts/01-object-store.md).
+- **File System Optimized (FSO):** An optimized layout for Hadoop Compatible
File System (HCFS) semantics, where intermediate directories are stored
separately, improving performance for file system operations like listing and
renaming.
+For more details, refer to the [Prefix FSO
documentation](./04-layouts/02-file-system-optimized.md).
+
+### Erasure Coding
+
+Erasure Coding (EC) can be enabled at the bucket level to define data
redundancy strategies. This allows for more efficient storage compared to
replication, especially for large datasets.
+For more information, see the [Erasure Coding
documentation](../../02-replication/04-erasure-coding.md).
+
+### Snapshots
+
+Ozone's snapshot feature allows users to take point-in-time consistent images
of a given bucket. These snapshots are immutable and can be used for backup,
recovery, archival, and incremental replication purposes.
+For more details, refer to the [Ozone Snapshot
documentation](./08-snapshots.md).
+
+### GDPR Compliance
+
+Ozone provides features to support GDPR compliance, particularly the "right to
be forgotten." When a GDPR-compliant bucket is created, encryption keys for
deleted data are immediately removed, making the data unreadable even if the
underlying blocks haven't been physically purged yet.
+For more details, refer to the [GDPR
documentation](https://ozone.apache.org/docs/edge/security/gdpr.html).
+
+### Bucket Linking
+
+Bucket linking allows exposing a bucket from one volume (or even another
bucket) as if it were in a different location, particularly useful for S3
compatibility or cross-tenant access. This creates a symbolic link-like
behavior.
+For more information, see the [S3 Protocol
documentation](../../../04-user-guide/01-client-interfaces/03-s3.md) and [S3
Multi-Tenancy
documentation](../../../05-administrator-guide/03-operations/07-s3-multi-tenancy.md).
+
+### Access Control Lists (ACLs)
+
+ACLs define permissions for buckets, controlling who can list keys, read/write
data, or delete the bucket.
+For more details, refer to the [Security ACLs
documentation](../../04-security/02-acls/01-native-acls.md).
diff --git a/docs/03-core-concepts/03-namespace/02-buckets/03-quotas.md
b/docs/03-core-concepts/03-namespace/02-buckets/03-quotas.md
index 91cec39ac..1ea3e182e 100644
--- a/docs/03-core-concepts/03-namespace/02-buckets/03-quotas.md
+++ b/docs/03-core-concepts/03-namespace/02-buckets/03-quotas.md
@@ -4,4 +4,7 @@ sidebar_label: Quotas
# Bucket Quotas
-**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
+## Quota Management
+
+Similar to volumes, buckets can also have storage space and namespace quotas
applied to them.
+For comprehensive information on configuring and managing quotas, see the
[Quota Management
documentation](../../../05-administrator-guide/03-operations/11-quota.md).
diff --git a/docs/03-core-concepts/03-namespace/02-buckets/06-encryption.md
b/docs/03-core-concepts/03-namespace/02-buckets/06-encryption.md
index 1f52d27ac..909c81c38 100644
--- a/docs/03-core-concepts/03-namespace/02-buckets/06-encryption.md
+++ b/docs/03-core-concepts/03-namespace/02-buckets/06-encryption.md
@@ -4,4 +4,8 @@ sidebar_label: Encryption
# Bucket Level Encryption
-**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
+## Transparent Data Encryption - TDE
+
+Buckets can be configured for Transparent Data Encryption (TDE) at the time of
creation.
+When TDE is enabled, all data written to the bucket is automatically encrypted
at rest using a specified encryption key.
+For detailed steps on setting up and using TDE, refer to the [Securing TDE
documentation](../../../05-administrator-guide/02-configuration/03-security/05-encryption/02-transparent-data-encryption.md).
diff --git a/docs/03-core-concepts/03-namespace/02-buckets/08-snapshots.md
b/docs/03-core-concepts/03-namespace/02-buckets/08-snapshots.md
new file mode 100644
index 000000000..d5da5df52
--- /dev/null
+++ b/docs/03-core-concepts/03-namespace/02-buckets/08-snapshots.md
@@ -0,0 +1,14 @@
+---
+sidebar_label: Snapshots
+---
+
+# Bucket Snapshots
+
+A Snapshot is a point-in-time, read-only image of a Bucket.
+It captures the exact state of the bucket at the moment of creation, allowing
users to access historical data or perform backups without interrupting ongoing
write operations.
+
+## Snapshot Key characteristics
+
+- **Instantaneous**: Snapshot creation is an O(1) operation. It utilizes
metadata within the Ozone Manager, making it extremely fast regardless of the
bucket's size.
+- **Efficient**: Snapshots do not duplicate data blocks physically. Storage
space is claimed only when the live data is modified or deleted, ensuring
storage efficiency.
+- **Accessible**: Users can access snapshot data through the virtual
`.snapshot` directory.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
