From b42fcb724dfaf62ffb47d0d264099b180eeef221 Mon Sep 17 00:00:00 2001 From: george-wu20250203 Date: Thu, 4 Dec 2025 05:59:04 +0000 Subject: [PATCH] Update storage and networking --- src/content/docs/basic/networking.mdx | 14 ++++- src/content/docs/service/storage/01-osd.mdx | 56 ++++++++++++------- src/content/docs/service/storage/02-pool.mdx | 12 +++- .../docs/service/storage/03-block-device.mdx | 19 ++++++- .../docs/service/storage/04-file-system.mdx | 54 +++++++++++++----- src/content/docs/service/storage/05-smb.mdx | 8 +++ .../docs/service/storage/06-object.mdx | 44 ++++++++++++--- 7 files changed, 157 insertions(+), 50 deletions(-) diff --git a/src/content/docs/basic/networking.mdx b/src/content/docs/basic/networking.mdx index 81d9690..c5c2ff4 100644 --- a/src/content/docs/basic/networking.mdx +++ b/src/content/docs/basic/networking.mdx @@ -5,7 +5,18 @@ description: Manage networking in OtterScale. import { Steps, Aside } from '@astrojs/starlight/components'; -This page allows you to manage the network infrastructure for the OtterScale cluster. You can configure fabrics, VLANs, and subnets to define how machines communicate within the cluster and with the external world. +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. + +## Overview + +#### Networks + +Displays the number of defined Fabric networks in the system. + +#### Available subnets + +Shows percentage and ratio of available (unallocated) IP addresses across all subnets. +This allows administrators to understand IP exhaustion trends and plan for expansion. ## Introduction @@ -23,6 +34,7 @@ The Networking page displays a list of configured networks. The table includes t ## Manage Networks +A Fabric represents a physical or logical L2 broadcast domain. Within each Fabric, you can define VLANs. Each VLAN containes one Subnet, which represent routable IP networks used for DHCP, PXE booting, and machine allocation. You can create new networks or manage existing ones using the **Actions** menu (three dots icon) in each row. ### Create a New Network diff --git a/src/content/docs/service/storage/01-osd.mdx b/src/content/docs/service/storage/01-osd.mdx index 269fd57..b327421 100644 --- a/src/content/docs/service/storage/01-osd.mdx +++ b/src/content/docs/service/storage/01-osd.mdx @@ -5,39 +5,53 @@ description: Monitor and manage Object Storage Daemons (OSDs). import { Steps, Aside } from '@astrojs/starlight/components'; -The OSD (Object Storage Daemon) page provides a comprehensive view of the storage daemons that manage data within your Ceph cluster. It allows you to monitor the health, performance, and usage of each OSD. +The OSD (Object Storage Daemon) page provides a detailed overview of the storage daemons in your Ceph cluster. +Each OSD represents a logical disk that maps to an underlying physical device such as NVMe, SSD, or HDD. -## Introduction +## Overview -The OSD page displays a list of all Object Storage Daemons. The table includes the following information: +At the top of the page, providing an overview of OSD status in the cluster. -| Column | Description | -| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Name** | The unique identifier of the OSD (e.g., `osd.0`). | -| **State** | The current status of the OSD. `Up` indicates the daemon is running and reachable. `In` indicates the OSD is in the cluster map and storing data. | -| **Exists** | Indicates whether the OSD physically exists and is recognized by the cluster. | -| **Device Class** | The type of storage medium used by the OSD (e.g., `hdd`, `ssd`, `nvme`). | -| **Machine** | The hostname of the physical machine hosting the OSD. Clicking the hostname navigates to the machine's details page. | -| **PG Count** | The number of Placement Groups (PGs) hosted on this OSD. | -| **Usage** | A progress bar showing the storage capacity usage (Used Space / Total Space). | -| **IOPS** | A real-time chart displaying the Input/Output Operations Per Second (Input vs. Output). | -| **Throughput** | A real-time chart displaying the data transfer rate (Read vs. Write). | +#### Count -## Manage OSDs +Shows the total number of OSDs detected by the cluster. -You can perform maintenance tasks on individual OSDs using the **Actions** menu. +#### Usage -### OSD Actions +Displays the overall raw storage usage across all OSDs, including the used and total storage capacity. -The **Actions** menu (three dots icon) for each OSD provides the following options: +## Introduction + +The OSD page lists all Object Storage Daemons currently available in the cluster. +Each row represents one OSD instance and includes the following information: + +| Column | Description | +| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| **Name** | The unique identifier of the OSD (e.g., `osd.0`). | +| **State** | Indicates the operational status. **Up** means the daemon is running. **In** means the OSD is included in the CRUSH map and is storing data. | +| **Exists** | Shows whether the OSD physically exists and is recognized by the cluster. | +| **Device Class** | The storage device type assigned to the OSD, such as `hdd`, `ssd`, or `nvme`. This information helps determine data placement and CRUSH behavior. | +| **Machine** | The hostname of the node hosting the OSD. Selecting the hostname opens the machine detail page. | +| **Placement Group** | The number of Placement Groups (PGs) currently assigned to the OSD. | +| **Usage** | A visual indicator showing the used and total storage capacity of the OSD (Used Space / Total Space). | +| **IOPS** | A real-time chart showing input and output operations per second (Input vs. Output). | +| **Throughput** | A real-time chart showing read and write data throughput (Read vs. Write). | + +## Manage OSDs + +Each OSD provides an Actions menu for administrative operations. #### View SMART -Displays S.M.A.R.T. (Self-Monitoring, Analysis and Reporting Technology) information of the underlying storage drive to check for hardware health and potential failures. +Retrieves S.M.A.R.T. (Self-Monitoring, Analysis and Reporting Technology) information from the physical disk associated with the OSD. +This data helps assess hardware health and identify potential failures. -1. Select **View SMART** from the actions menu. -2. The system will display the S.M.A.R.T. information. +1. Open the Actions menu for the selected OSD. +2. Click **Do S.M.A.R.T.** +3. A dialog will appear showing the full S.M.A.R.T. report for the device. + + diff --git a/src/content/docs/service/storage/02-pool.mdx b/src/content/docs/service/storage/02-pool.mdx index 078efdf..89572e1 100644 --- a/src/content/docs/service/storage/02-pool.mdx +++ b/src/content/docs/service/storage/02-pool.mdx @@ -7,6 +7,13 @@ import { Steps, Aside } from '@astrojs/starlight/components'; 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. +## Overview + +At the top of the page, providing an overview of the pool state in the cluster. + +### Pool +Shows the total number of pools currently defined in the system. + ## Introduction The Pool page displays a list of all storage pools. The table includes the following information: @@ -17,11 +24,12 @@ The Pool page displays a list of all storage pools. The table includes the follo | **Type** | The type of the pool, either `Replicated` (copies data) or `Erasure` (uses erasure coding for efficiency). It also displays configuration details like replica count or erasure coding profile (k+m). | | **Applications** | The applications enabled for this pool (e.g., `rbd`, `cephfs`, `rgw`). | | **PG State** | The state of the Placement Groups (PGs) within the pool (e.g., `active`, `clean`, `degraded`). | -| **Usage** | A progress bar showing the storage capacity usage (Used Space / Total Space). | +| **Usage** | A progress bar indicating the amount of data stored in the pool relative to its total logical capacity. | ## Create Pool You can create new storage pools to meet specific application requirements. +The create dialog includes configuration fields for pool type, replica size or erasure coding settings, application assignment, and optional quotas. @@ -32,7 +40,7 @@ You can create new storage pools to meet specific application requirements. - **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 the applications that will use this pool (e.g., `rbd`, `cephfs`, `rgw`). +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: - **Max Bytes**: The maximum amount of data (in GB or TB) the pool can store. - **Max Objects**: The maximum number of objects the pool can store. diff --git a/src/content/docs/service/storage/03-block-device.mdx b/src/content/docs/service/storage/03-block-device.mdx index 315b491..bb14959 100644 --- a/src/content/docs/service/storage/03-block-device.mdx +++ b/src/content/docs/service/storage/03-block-device.mdx @@ -7,6 +7,17 @@ import { Steps, Aside } from '@astrojs/starlight/components'; 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. +## Overview + +At the top of the page, providing a quick overview of RBD usage in the cluster. + +### Images +Shows the total number of RADOS Block Device images currently stored across all pools. + +### Usage +Displays the combined usage of all block device images. +Including the total used capacity and total provisioned quota, helping administrators assess storage consumption at a glance. + ## Introduction The Block Device page displays a list of all RBD images. The table includes the following information: @@ -41,12 +52,15 @@ You can modify or delete existing block devices using the **Actions** menu. ### Edit Block Device -Allows you to resize the block device. +Allows you to expand or shrink the block device. + 1. Select **Edit** from the actions menu (pencil icon). -2. Update the **Quota Size** to expand or shrink the device. +2. Update the **Quota Size** to increase the device size. 3. Click **Confirm** to save changes. @@ -81,7 +95,6 @@ The snapshot list displays the following information: | **Name** | The name of the snapshot. | | **Protect** | Indicates whether the snapshot is protected from deletion. | | **Usage** | A progress bar showing the storage usage of the snapshot. | -| **Actions** | Provides options to manage the snapshot (Rollback, Protect, Unprotect, Delete). | ### Snapshot Actions diff --git a/src/content/docs/service/storage/04-file-system.mdx b/src/content/docs/service/storage/04-file-system.mdx index 2179357..d25898b 100644 --- a/src/content/docs/service/storage/04-file-system.mdx +++ b/src/content/docs/service/storage/04-file-system.mdx @@ -13,18 +13,24 @@ The page is divided into two main sections: **NFS** and **Group**. The NFS section allows you to manage subvolumes and export them via NFS. +## Overview + +#### NFS + +Shows the total number of NFS exports created from CephFS subvolumes. + ### Introduction The NFS table displays a list of subvolumes. The table includes the following information: -| Column | Description | -| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| **Name** | The name of the subvolume. | -| **Pool Name** | The data pool where the subvolume is stored. | -| **Export** | Displays the NFS export path and allowed clients (IPs). Clicking the copy icon copies the mount command. | -| **Usage** | A progress bar showing the storage capacity usage (Used Space / Quota Size). | -| **Created At** | The creation timestamp of the subvolume. | -| **Snapshots** | The number of snapshots taken of this subvolume. Clicking the external link icon opens a detailed view of the [snapshots](#snapshot-list). | +| Column | Description | +| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| **Name** | The name of the subvolume. | +| **Pool Name** | The data pool where the subvolume is stored. | +| **Export** | Displays the NFS export path and allowed clients (IPs). Clicking the copy icon copies the mount command. | +| **Usage** | A progress bar showing the storage capacity usage (Used Space / Quota Size). | +| **Created Time** | The creation timestamp of the subvolume. | +| **Snapshots** | The number of snapshots taken of this subvolume. Clicking the external link icon opens a detailed view of the [snapshots](#snapshot-list). | ### Create NFS Export @@ -75,6 +81,10 @@ Permanently removes the subvolume and its export. + + ### Manage Snapshots Snapshots provide a read-only copy of the subvolume at a specific point in time. You can view and manage snapshots by clicking the external link icon in the **Snapshots** column. @@ -87,26 +97,36 @@ The snapshot list displays the following information: | :----------------- | :---------------------------------------------------------------- | | **Name** | The name of the snapshot. | | **Pending Clones** | Indicates if there are any pending clones based on this snapshot. | -| **Created At** | The creation timestamp of the snapshot. | -| **Actions** | Provides options to manage the snapshot (Delete). | +| **Created Time** | The creation timestamp of the snapshot. | #### Snapshot Actions - **Delete**: Permanently removes the snapshot. + + ## Group The Group section allows you to manage subvolume groups, which are used to organize subvolumes. +## Overview + +#### Group + +Shows the total number of subvolume groups defined in the file system. + ### Introduction The Group table displays a list of subvolume groups. The table includes the following information: -| Column | Description | -| :------------- | :--------------------------------------- | -| **Name** | The name of the subvolume group. | -| **Pool Name** | The data pool associated with the group. | -| **Created At** | The creation timestamp of the group. | +| Column | Description | +| :--------------- | :-------------------------------------------------------------------------- | +| **Name** | The name of the subvolume group. | +| **Pool Name** | The data pool associated with the group. | +| **Usage** | A progress bar showing the cumulative usage of all subvolumes in the group. | +| **Created Time** | The creation timestamp of the group. | ### Create Group @@ -139,3 +159,7 @@ Permanently removes a subvolume group. 3. Click **Confirm** to permanently delete the group. + + diff --git a/src/content/docs/service/storage/05-smb.mdx b/src/content/docs/service/storage/05-smb.mdx index 38e4436..9d8c480 100644 --- a/src/content/docs/service/storage/05-smb.mdx +++ b/src/content/docs/service/storage/05-smb.mdx @@ -7,6 +7,14 @@ import { Steps } from '@astrojs/starlight/components'; 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. +## Overview + +At the top of the page, providing an overview of the SMB configuration. + +### SMB Shares + +Shows the total number of SMB shares created on the system. + ## Introduction The SMB table displays a list of all SMB shares. The table includes the following information: diff --git a/src/content/docs/service/storage/06-object.mdx b/src/content/docs/service/storage/06-object.mdx index f0a5cec..86b44aa 100644 --- a/src/content/docs/service/storage/06-object.mdx +++ b/src/content/docs/service/storage/06-object.mdx @@ -13,16 +13,26 @@ The page is divided into two main sections: **Bucket** and **User**. The Bucket section allows you to manage S3 buckets. +## Overview + +At the top of the page, providing a quick overview of the RGW configuration. + +### Buckets +Shows the total number of S3 buckets created in the system. + +### Usage +Shows the total storage consumption across all buckets, including object size and metadata. + ### Introduction 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 At** | 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** | The creation timestamp of the bucket. | ### Create Bucket @@ -67,10 +77,21 @@ Permanently removes a bucket and all its objects. + + ## User The User section allows you to manage RGW users and their access keys. +## Overview + +At the top of the page, providing a quick overview of the RGW configuration. + +### Users +Displays the total number of RGW users. + ### Introduction The User table displays a list of all users. The table includes the following information: @@ -78,7 +99,7 @@ The User table displays a list of all users. The table includes the following in | Column | Description | | :------------ | :---------------------------------------------------------------------------------------------------------------------------------- | | **ID** | The unique identifier of the user. | -| **User** | The display name of the user. | +| **Name** | The display name of the user. | | **Suspended** | Indicates whether the user account is suspended. | | **Key** | The number of access keys associated with the user. Clicking the external link icon opens a detailed view of the [keys](#key-list). | @@ -124,6 +145,10 @@ Permanently removes a user. + + ### Manage Keys Access keys are used to authenticate requests to the object storage service. You can view and manage keys by clicking the external link icon in the **Key** column. @@ -135,7 +160,6 @@ The key list displays the following information: | Column | Description | | :------------- | :------------------------------------------- | | **Access Key** | The access key ID. | -| **Actions** | Provides options to manage the key (Delete). | #### Create Key @@ -158,3 +182,7 @@ Permanently removes an access key. 2. Confirm the deletion. + + \ No newline at end of file