Skip to content

Fix/add object detail #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KUASWoodyLIN merged 3 commits into from
Jan 5, 2026
Merged

Fix/add object detail #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3944f83
Add object detail
terrywu510 Jan 2, 2026
8fa3f88
Fix create step
terrywu510 Jan 2, 2026
709c33e
Use S3 browser access RGW
terrywu510 Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/content/docs/service/storage/02-pool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ The create dialog includes configuration fields for pool type, replica size or e
- **Replicated Size**: Specify the number of replicas (e.g., 3).
- **Erasure**: Uses erasure coding to save space. Ideal for cold storage or large datasets.
- **EC Overwrite**: Enable if you need to support overwrites (required for RBD/CephFS on EC pools).
4. **Applications**: Select one or more applications that will use this pool (e.g., `rbd`, `cephfs`, `rgw`).
5. **Quota**: Optionally set limits on the pool's usage:
4. **Quota**: Optionally set limits on the pool's usage:
- **Max Bytes**: The maximum amount of data (in GB or TB) the pool can store.
5. **Advanced Settings (Optional)**:
- **Max Objects**: The maximum number of objects the pool can store.
Comment on lines +46 to 49

@gemini-code-assist gemini-code-assist Bot Jan 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The "Applications" step has been removed from the pool creation process in the documentation. However, the "Applications" column is still listed in the pool overview table (line 28), suggesting it's an important property. Was this removal intentional? If users can no longer set applications during creation, it would be helpful to document how this property is assigned. If it was an accidental removal, please consider adding it back.

6. Click **Confirm** to create the pool.

Expand All @@ -62,7 +62,7 @@ Allows you to modify the pool's configuration, such as quotas.
<Steps>

1. Select **Edit** from the actions menu (pencil icon).
2. Update the **Name**, **Quota Size**, or **Quota Objects** as needed.
2. Update the **Quota Size**, or **Quota Objects** as needed.
3. Click **Confirm** to save changes.

</Steps>
Expand Down
48 changes: 38 additions & 10 deletions src/content/docs/service/storage/06-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ At the top of the page, you will find a dashboard summarizing the state of S3 st

<CardGrid>
<Card title="Bucket" icon="tabler:bucket">
The total number of S3 buckets currently defined in the system.
The total number of S3 buckets currently defined in the system.

The RGW endpoint IP that clients use to access the bucket via S3-compatible APIs.
</Card>
Comment on lines 21 to 25

@gemini-code-assist gemini-code-assist Bot Jan 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The information about the RGW endpoint seems misplaced within the "Bucket" card, which primarily describes the total count of buckets. The RGW endpoint is a service-level detail that applies to all buckets. Consider moving this information to a more general location, such as the introductory paragraph of the "Bucket" section (around line 14) or the main "Object" page introduction (around line 8), for better logical organization.

<Card title="Usage" icon="tabler:chart-pie">
The combined storage consumption across all buckets, including object data and metadata overhead.
Expand All @@ -30,12 +32,12 @@ At the top of the page, you will find a dashboard summarizing the state of S3 st

The Bucket table displays a list of all buckets. The table includes the following information:

| Column | Description |
| :--------------- | :---------------------------------------------- |
| **Name** | The name of the bucket. |
| **Owner** | The user ID of the bucket owner. |
| **Usage** | The total size of objects stored in the bucket. |
| **Created Time** | The creation timestamp of the bucket. |
| Column | Description |
| :--------------- | :-------------------------------------------------------------------------- |
| **Name** | The name of the bucket. |
| **Owner** | The user ID of the bucket owner. |
| **Usage** | The total size of objects stored in the bucket. |
| **Created Time** | Displays how long ago the bucket was created, relative to the current time. |

### Create Bucket

Expand All @@ -52,6 +54,32 @@ You can create new buckets to store your data.

</Steps>

### Access Bucket with S3 Browser

This section demonstrates how to access a Ceph Object Gateway (RGW) bucket using S3 Browser, a graphical S3 client.
This approach is useful for manual verification, browsing objects, and basic upload/download operations without writing code.

#### Prerequisites
- S3 Browser installed on the client machine (Windows).

<Steps>

1. Create a user in User section.
2. Create an access key for the user and copy the secret key.
3. Create a bucket and assign the user as the owner. The bucket owner always has full control of the bucket regardless of the selected ACL.
4. Open S3 Browser.
5. Fill in the account settings:
- Account type: S3 compatible storage
- API endpoint: RGW endpoint
- Access Key ID: User’s access key.
- Secret Access Key: The copied secret key.
- Use secure transfer: Disable SSL
6. Add new account

</Steps>



Comment on lines +67 to +82

@gemini-code-assist gemini-code-assist Bot Jan 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This new section is a great addition! To make it even clearer for users, I've suggested a few improvements:

  • Made "User section" a markdown link for easier navigation.
  • Made the instructions for Access Key ID and Secret Access Key more specific by referring back to the step where they were created.
  • Removed several extra blank lines for cleaner formatting.

Additionally, in step 5, could you clarify where the user can find the RGW endpoint value? It would be helpful to mention if it's displayed somewhere in the UI.

1. Create a user in the [User section](#user).
2. Create an access key for the user and copy the secret key.
3. Create a bucket and assign the user as the owner. The bucket owner always has full control of the bucket regardless of the selected ACL.
4. Open S3 Browser.
5. Fill in the account settings:
	- Account type: S3 compatible storage
	- API endpoint: RGW endpoint
	- Access Key ID: The access key generated in step 2.
	- Secret Access Key:  The secret key copied in step 2.
	- Use secure transfer: Disable SSL
6. Add new account

</Steps>

### Manage Buckets

You can modify or delete existing buckets using the **Actions** menu.
Expand Down Expand Up @@ -81,7 +109,7 @@ Permanently removes a bucket and all its objects.
</Steps>

<Aside type="danger">
Deleting a Object bucket is irreversible. Ensure that you have backed up any critical data.
Deleting an Object bucket is irreversible. Ensure that you have backed up any critical data.
</Aside>

## User
Expand Down Expand Up @@ -152,7 +180,7 @@ Permanently removes a user.
</Steps>

<Aside type="danger">
Deleting a Object user is irreversible. Ensure that you have backed up any critical data.
Deleting an Object user is irreversible. Ensure that you have backed up any critical data.
</Aside>

### Manage Keys
Expand Down Expand Up @@ -190,5 +218,5 @@ Permanently removes an access key.
</Steps>

<Aside type="danger">
Deleting a Object key is irreversible. Ensure that you have backed up any critical data.
Deleting an Object key is irreversible. Ensure that you have backed up any critical data.
</Aside>
Loading