Skip to content

Commit e4947e0

Browse files
KUASWoodyLINKUASWoodyLIN
authored
Merge pull request #36 from otterscale/feate/update_storage_networking
Add Statistics Overview and card
2 parents 13ad9e6 + 777bfde commit e4947e0

7 files changed

Lines changed: 82 additions & 58 deletions

File tree

‎src/content/docs/basic/networking.mdx‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,22 @@ title: Networking
33
description: Manage networking in OtterScale.
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
This page allows you to manage the network infrastructure for the OtterScale cluster. You can manage network fabrics, VLANs, and subnets for machine provisioning and service connectivity.
99

10-
## Overview
10+
### Statistics Overview
1111

12-
#### Networks
12+
At the top of the page, a set of summary cards provides a quick overview of the configured networking resources.:
1313

14-
Displays the number of defined Fabric networks in the system.
15-
16-
#### Available subnets
17-
18-
Shows percentage and ratio of available (unallocated) IP addresses across all subnets.
19-
This allows administrators to understand IP exhaustion trends and plan for expansion.
14+
<CardGrid>
15+
<Card title="Networks" icon="tabler:topology-star">
16+
Total number of Fabrics available for network segmentation.
17+
</Card>
18+
<Card title="Available Subnets" icon="">
19+
Overall utilization of IP address space across all subnets.
20+
</Card>
21+
</CardGrid>
2022

2123
## Introduction
2224

‎src/content/docs/service/storage/01-osd.mdx‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,23 @@ title: OSD
33
description: Monitor and manage Object Storage Daemons (OSDs).
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The OSD (Object Storage Daemon) page provides a detailed overview of the storage daemons in your Ceph cluster.
99
Each OSD represents a logical disk that maps to an underlying physical device such as NVMe, SSD, or HDD.
1010

11-
## Overview
11+
### Statistics Overview
1212

13-
At the top of the page, providing an overview of OSD status in the cluster.
13+
At the top of the page, you will find a dashboard summarizing the state of OSD capacity and availability across the cluster:
1414

15-
#### Count
16-
17-
Shows the total number of OSDs detected by the cluster.
18-
19-
#### Usage
20-
21-
Displays the overall raw storage usage across all OSDs, including the used and total storage capacity.
15+
<CardGrid>
16+
<Card title="Count" icon="">
17+
The total number of OSDs detected by the cluster.
18+
</Card>
19+
<Card title="Usage" icon="">
20+
The percentage of overall raw storage usage across all OSDs.
21+
</Card>
22+
</CardGrid>
2223

2324
## Introduction
2425

‎src/content/docs/service/storage/02-pool.mdx‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@ title: Pool
33
description: Manage Ceph storage pools.
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The Pool page allows you to manage Ceph storage pools, which are logical partitions for storing objects. Pools provide a layer of abstraction between clients and the underlying OSDs, allowing you to configure data durability, availability, and performance policies.
99

10-
## Overview
10+
### Statistics Overview
1111

12-
At the top of the page, providing an overview of the pool state in the cluster.
12+
At the top of the page, you will find a dashboard summarizing the state of pool configuration within the cluster:
1313

14-
### Pool
15-
Shows the total number of pools currently defined in the system.
14+
<CardGrid>
15+
<Card title="Pool" icon="tabler:stack">
16+
The total number of storage pools currently defined in the system.
17+
</Card>
18+
</CardGrid>
1619

1720
## Introduction
1821

‎src/content/docs/service/storage/03-block-device.mdx‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,22 @@ title: Block Device
33
description: Manage Ceph RADOS Block Devices (RBD).
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The Block Device page allows you to manage Ceph RADOS Block Devices (RBD). RBDs are block-based storage devices that are striped across the cluster, providing high-performance and reliable storage for virtual machines, containers, and other applications.
99

10-
## Overview
10+
### Statistics Overview
1111

12-
At the top of the page, providing a quick overview of RBD usage in the cluster.
12+
At the top of the page, you will find a dashboard summarizing the state of RBD images stored in the cluster:
1313

14-
### Images
15-
Shows the total number of RADOS Block Device images currently stored across all pools.
16-
17-
### Usage
18-
Displays the combined usage of all block device images.
19-
Including the total used capacity and total provisioned quota, helping administrators assess storage consumption at a glance.
14+
<CardGrid>
15+
<Card title="Image" icon="tabler:database">
16+
The total number of RADOS Block Device (RBD) images currently stored across all pools.
17+
</Card>
18+
<Card title="Usage" icon="tabler:chart-bar">
19+
Displays the aggregated storage usage of all block device images, including total used capacity and total provisioned quota.
20+
</Card>
21+
</CardGrid>
2022

2123
## Introduction
2224

‎src/content/docs/service/storage/04-file-system.mdx‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: File System
33
description: Manage Ceph File Systems (CephFS) and NFS exports.
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The File System page allows you to manage Ceph File Systems (CephFS) and Network File System (NFS) exports. CephFS provides a POSIX-compliant file system on top of the Ceph cluster, while NFS exports allow you to share these file systems with standard NFS clients.
99

@@ -13,11 +13,15 @@ The page is divided into two main sections: **NFS** and **Group**.
1313

1414
The NFS section allows you to manage subvolumes and export them via NFS.
1515

16-
## Overview
16+
### Statistics Overview
1717

18-
#### NFS
18+
At the top of the page, you will find a dashboard summarizing the state of NFS exports configured in the system:
1919

20-
Shows the total number of NFS exports created from CephFS subvolumes.
20+
<CardGrid>
21+
<Card title="NFS" icon="">
22+
The total number of NFS exports created from CephFS subvolumes.
23+
</Card>
24+
</CardGrid>
2125

2226
### Introduction
2327

@@ -111,11 +115,15 @@ The snapshot list displays the following information:
111115

112116
The Group section allows you to manage subvolume groups, which are used to organize subvolumes.
113117

114-
## Overview
118+
### Statistics Overview
115119

116-
#### Group
120+
At the top of the page, you will find a dashboard summarizing the state of subvolume groups configured in the file system:
117121

118-
Shows the total number of subvolume groups defined in the file system.
122+
<CardGrid>
123+
<Card title="Group" icon="">
124+
The total number of subvolume groups defined in the file system.
125+
</Card>
126+
</CardGrid>
119127

120128
### Introduction
121129

‎src/content/docs/service/storage/05-smb.mdx‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@ title: SMB
33
description: Manage Samba (SMB) shares.
44
---
55

6-
import { Steps } from '@astrojs/starlight/components';
6+
import { Steps, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The SMB page allows you to manage Samba (SMB) shares, enabling file sharing across your network with Windows and other SMB-compatible clients. You can configure security modes, user access, and share properties.
99

10-
## Overview
10+
### Statistics Overview
1111

12-
At the top of the page, providing an overview of the SMB configuration.
12+
At the top of the page, you will find a dashboard summarizing the state of SMB shares configured in the system:
1313

14-
### SMB Shares
15-
16-
Shows the total number of SMB shares created on the system.
14+
<CardGrid>
15+
<Card title="SMB Shares" icon="">
16+
The total number of SMB shares currently defined in the system.
17+
</Card>
18+
</CardGrid>
1719

1820
## Introduction
1921

‎src/content/docs/service/storage/06-object.mdx‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Object
33
description: Manage Ceph Object Gateway (RGW) buckets and users.
44
---
55

6-
import { Steps, Aside } from '@astrojs/starlight/components';
6+
import { Steps, Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

88
The Object page allows you to manage the Ceph Object Gateway (RGW), which provides an S3-compatible object storage interface. You can manage buckets for storing objects and users for controlling access.
99

@@ -13,15 +13,18 @@ The page is divided into two main sections: **Bucket** and **User**.
1313

1414
The Bucket section allows you to manage S3 buckets.
1515

16-
## Overview
16+
### Statistics Overview
1717

18-
At the top of the page, providing a quick overview of the RGW configuration.
18+
At the top of the page, you will find a dashboard summarizing the state of S3 storage:
1919

20-
### Buckets
21-
Shows the total number of S3 buckets created in the system.
22-
23-
### Usage
24-
Shows the total storage consumption across all buckets, including object size and metadata.
20+
<CardGrid>
21+
<Card title="Bucket" icon="tabler:bucket">
22+
The total number of S3 buckets currently defined in the system.
23+
</Card>
24+
<Card title="Usage" icon="tabler:chart-pie">
25+
The combined storage consumption across all buckets, including object data and metadata overhead.
26+
</Card>
27+
</CardGrid>
2528

2629
### Introduction
2730

@@ -85,12 +88,15 @@ Permanently removes a bucket and all its objects.
8588

8689
The User section allows you to manage RGW users and their access keys.
8790

88-
## Overview
91+
### Statistics Overview
8992

90-
At the top of the page, providing a quick overview of the RGW configuration.
93+
At the top of the page, you will find a dashboard summarizing the state of S3 user management:
9194

92-
### Users
93-
Displays the total number of RGW users.
95+
<CardGrid>
96+
<Card title="User Shares" icon="tabler:users">
97+
The total number of S3 users registered in the system.
98+
</Card>
99+
</CardGrid>
94100

95101
### Introduction
96102

0 commit comments

Comments
 (0)