SupportConsoleDevelopersStart a trialContact

Chapter 13. Managing file systems using the Ceph dashboard

As a storage administrator, you can create, edit, delete, and manage accesses of file systems on the Red Hat Ceph Storage dashboard.

13.1. Configuring CephFS volumes

As a storage administrator, you can configure Ceph File System (CephFS) volumes on the Red Hat Ceph Storage dashboard.

13.1.1. Creating CephFS volumes

You can create Ceph File System (CephFS) volumes on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with MDS deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. Click Create.

  3. In the Create Volume window, set the following parameters:

    1. Name: Set the name of the volume.
    2. Placement (Optional): Select the placement of the volume. You can set it as either Hosts or Label.

    3. Hosts/Label (Optional): If placement is selected as Hosts in the previous option, then select the appropriate host from the list. If placement is selected as Label in the previous option, then enter the label.

      [IMPORTANT]: To identify the label that has been created for the hosts while using it as a placement, you can run the following command from the CLI: 

      [ceph: root@ceph-hk-ds-uoayxl-node1-installer /]# ceph orch host ls

HOST ADDR LABELS STATUS

host01 10.0.210.182 _admin,installer,mon,mgr
host02 10.0.96.72 mon,mgr
host03 10.0.99.37 mon,mds
host04 10.0.99.244 osd,mds
host05 10.0.98.118 osd,mds
host06 10.0.98.66 osd,nfs,mds
host07 10.0.98.23 nfs,mds
7 hosts in cluster

  4. Click Create Volume.

    1. A notification displays that the volume was created successfully.

13.1.2. Editing CephFS volumes

You can edit Ceph File System (CephFS) volumes on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the volume to be edited and click Edit.

  3. In the Edit File System window, rename the volume as required and click Edit File System.

    A notification displays that the volume was edited successfully.

13.1.3. Removing CephFS volumes

You can remove Ceph File System (CephFS) volumes on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the volume to be removed and click Remove from the action drop-down.

  3. In the Remove File System window, select Yes, I am sure and click Remove File System.

    A notification displays that the volume was removed successfully.

13.2. Configuring CephFS subvolume groups

As a storage administrator, you can configure Ceph File System (CephFS) subvolume groups on the Red Hat Ceph Storage dashboard.

13.2.1. Creating CephFS subvolume groups

You can create subvolume groups to create subvolume on the dashboard. You can also use subvolume groups to apply policies across a set of subvolumes.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row for which you want to create subvolumes and expand the row.
  3. From the Subvolume groups tab, click 'Create' to create a subvolume group.

  4. In the Create Subvolume group window, enter the following parameters:

    1. Name: Set the name of the subvolume group.
    2. Volume name: Validate that the correct name of the volume is selected.
    3. Size: Set the size of the subvolume group. If left blank or entered as 0, then, by default, the size will be set as infinite.
    4. Pool: Set the pool of the subvolume group. By default, data_pool_layout of the parent directory is selected.
    5. UID: Set the UID of the subvolume group.
    6. GID: Set the GID of the subvolume group.
    7. Mode: Set the permissions for the directory. By default, the mode is 755 which is rwxr-xr-x.

  5. Click Create Subvolume group.

    A notification displays that the subvolume group was created successfully.

13.2.2. Editing CephFS subvolume groups

You can edit the subvolume groups on the dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row for which you want to edit a subvolumes and expand the row.
  3. From the Subvolume groups tab, select the row containing the group that you want to edit.
  4. Click Edit to edit a subvolume group.

  5. In the Edit Subvolume group window, edit the needed parameters and click Edit Subvolume group.

    A notification displays that the subvolume group was edited successfully.

13.2.3. Removing CephFS subvolume groups

You can remove Ceph File System (CephFS) subvolume groups on the Red Hat Ceph Storage dashboard.

Warning

Ensure to remove the subvolume within the subvolume group before removing the subvolume group.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row for which you want to remove a subvolume and expand the row.
  3. Under the Subvolume groups tab, select the subvolume group you want to remove, and click Remove from the action drop-down.

  4. In the Remove Subvolume group window, select 'Yes, I am sure', and click Remove Subvolume group.

    A notification displays that the subvolume group was removed successfully.

13.3. Configuring CephFS subvolumes

As a storage administrator, you can configure Ceph File System (CephFS) subvolumes on the Red Hat Ceph Storage dashboard.

13.3.1. Creating CephFS subvolume

You can create Ceph File System (CephFS) subvolume on the Red Hat Ceph Storage dashboard.

Warning

Ensure to remove the subvolume within the subvolume group before removing the subvolume group.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row.

  3. Under the Subvolume tab, select the Subvolume group in which you want to create the subvolume.

    Note

    If you select the Default option, the subvolumes are not created under any subvolume groups.

  4. Click Create to create a subvolume.

  5. In the Create Subvolume window, enter the following parameters:

    1. Name: Set the name of the subvolume group.
    2. Subvolume name: Set the name of the volume.
    3. Size: Set the size of the subvolume group. If left blank or entered as 0, then, by default, the size will be set as infinite.
    4. Pool: Set the pool of the subvolume group. By default, data_pool_layout of the parent directory is selected.
    5. UID: Set the UID of the subvolume group.
    6. GID: Set the GID of the subvolume group.
    7. Mode: Set the permissions for the directory. By default, the mode is 755 which is rwxr-xr-x.
    8. Isolated Namespace: If you want to create the subvolume in a separate RADOS namespace, select this option.

  6. Click Create Subvolume.

    A notification that the subvolume was created successfully is displayed.

13.3.2. Editing CephFS subvolume

You can edit Ceph File System (CephFS) subvolume on the Red Hat Ceph Storage dashboard.

Note

You can only edit the size of the subvolumes on the dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.
  • A subvolume created.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row.
  3. Under the Subvolume tab, select the subvolume you want to edit, and click Edit within the volume.
  4. Click Create to create a subvolume.

  5. In the Edit Subvolume window, enter the following parameters:

    1. Name: Set the name of the subvolume group.
    2. Subvolume name: Set the name of the volume.
    3. Size: Set the size of the subvolume group. If left blank or entered as 0, then, by default, the size will be set as infinite.
    4. Pool: Set the pool of the subvolume group. By default, data_pool_layout of the parent directory is selected.
    5. UID: Set the UID of the subvolume group.
    6. GID: Set the GID of the subvolume group.
    7. Mode: Set the permissions for the directory. By default, the mode is 755 which is rwxr-xr-x.

  6. Click Edit Subvolume.

    A notification that the subvolume was created successfully is displayed.

13.3.3. Removing CephFS subvolume

You can remove Ceph File System (CephFS) subvolume on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A working Red Hat Ceph Storage cluster with Ceph File System deployed.
  • A subvolume created.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. From the listed volumes, select the row.
  3. Navigate to Subvolume tab, select the subvolume you want to remove, and click Remove.

  4. In the Remove Subvolume window, confirm whether you want to remove the selected subvolume and click Remove Subvolume.

    A notification that the subvolume was removed successfully is displayed.

13.4. Managing CephFS snapshots

As a storage administrator, you can cretate Ceph File System (CephFS) volume and subvolume snapshots on the Red Hat Ceph Storage dashboard.

The Ceph File System (CephFS) snapshots create an immutable, point-in-time view of a Ceph File System. CephFS snapshots are asynchronous and are kept in a special hidden directory in the CephFS directory named .snap. You can specify snapshot creation for any directory within a Ceph File System. When specifying a directory, the snapshot also includes all the subdirectories beneath it.

CephFS snapshot feature is enabled by default on new Ceph File Systems, but it must be manually enabled on existing Ceph File Systems.

Warning

Each Ceph Metadata Server (MDS) cluster allocates the snap identifiers independently. Using snapshots for multiple Ceph File Systems that are sharing a single pool causes snapshot collisions, and results in missing file data.

13.4.1. Creating CephFS subvolume snapshots

As a storage administrator, you can create Ceph File System (CephFS) subvolume snapshot on the Red Hat Ceph Storage dashboard. You can create an immutable, point-in-time view of a Ceph File System (CephFS) by creating a snapshot.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A subvolume group with corresponding subvolumes.

Procedure

  1. Log into the dashboard.
  2. On the dashboard navigation menu, click File > File Systems.

  3. Select the CephFS where you want to create the subvolune snapshot.

    If there are no file systems available, create a new file system.

  4. Go to the Snapshots tab. There are three columns - Groups, Subvolumes, and Create.
  5. From the Groups and Subvolumes columns, select the group and the subvolume for which you want to create a snapshot.

  6. Click Create in the third column. The Create snapshot form opens.

    1. Name: A default name (date and time of the creation of snapshot) is already added. You can edit this name and add a new name.
    2. Volume name: The volume name is the file system name. It is already added to the form as per your selection.
    3. Subvolume group: The subvolume group name is already added as per your selection. Alternatively, you select a different subvolume group from the dropdown list.
    4. Subvolume: The subvolume name is already added as per your selection. Alternatively, you can select a different subvolume from the dropdown list.

  7. Click Create Snapshot.

    A notification is displayed that the snapshot is created successfully.

Verification

  • Navigate to the Snapshots tab, select the subvolume and subvoume group for which the snapshot is created.

13.4.2. Deleting CephFS subvolume snapshots

As a storage administrator, you can create Ceph File System (CephFS) subvolume snapshot on the Red Hat Ceph Storage dashboard. You can create an immutable, point-in-time view of a Ceph File System (CephFS) by creating a snapshot.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A subvolume group with corresponding subvolumes.

Procedure

  1. Log into the dashboard.
  2. On the dashboard navigation menu, click File > File Systems.
  3. Select the CephFS where you want to delete the subvolume snapshot.
  4. Go to the Snapshots tab.
  5. Select the snapshot you want to delete. You can list the snapshot by selecting the subvolume group and subvoume for which the snapshot is created.
  6. Check the box 'Yes, I am sure' to confirm you want to delete the snapshot.

  7. Click Delete Snapshot.

    A notification is displayed that the snapshot is deleted successfully.

13.4.3. Cloning CephFS subvolume snapshots

As a storage administrator, you can clone Ceph File System (CephFS) subvolume snapshot on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A subvolume snapshot.

Procedure

  1. Log into the dashboard.
  2. On the dashboard navigation menu, click File > File Systems.
  3. Select the CephFS where you want to clone the subvolume snapshot.
  4. Go to the Snapshots tab.
  5. Select the snapshot you want to clone. You can list the snapshot by selecting the subvolume group and subvoume for which the snapshot is created. Check the box 'Yes, I am sure' to confirm you want to delete the snapshot.
  6. Click the arrow next to the Delete button.

  7. Click Clone and configure the following.

    1. Name: A default name (date and time of the creation of clone) is already added. You can change this name and add a new name.
    2. Group name: The subvolume group name is already added as per your selection. Alternatively, you select a different subvolume group from the dropdown list.

  8. Click Create Clone.

    A notification is displayed that the clone is created successfully.

  9. You can verify that the clone is created by going to the Snapshots tab, in the Subvolume column. Select the subvoume group for which the clone is created.

13.4.4. Creating CephFS volume snapshots

As a storage administrator, you can create Ceph File System (CephFS) volume snapshot on the IBM Storage Ceph dashboard. You can create an immutable, point-in-time view of a Ceph File System (CephFS) volume by creating a snapshot.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A subvolume group with corresponding subvolumes.

Procedure

  1. Log into the dashboard.
  2. On the dashboard navigation menu, click File > File Systems.

  3. Select the CephFS where you want to create the subvolume snapshot.

    If there are no file systems available, create a new file system.

  4. Go to the Directories tab.
  5. From the list of the subvolume and volumes, select the volume for which you want to create the snapshot.

  6. Click Create in the Snapshot row. The Create Snapshot form opens.

    1. Name: A default name (date and time of the creation of snapshot) is already added. You can edit this name and add a new name.

  7. Click Create Snapshot.

    A notification is displayed that the snapshot is created successfully.

  8. You can verify that the snapshot is created from the Snapshots row in the Directories tab

13.4.5. Deleting CephFS volume snapshots

As a storage administrator, you can delete Ceph File System (CephFS) volume snapshot on the Red Hat Ceph Storage dashboard.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A volume snapshot.

Procedure

  1. Log into the dashboard.
  2. On the dashboard navigation menu, click File > File Systems.
  3. Select the CephFS where you want to delete the subvolume snapshot.
  4. Go to the Directories tab.
  5. Select the snapshot you want to delete. You can see list of snapshots in the Snapshot row.
  6. Click 'Delete'.
  7. Check the box Yes, I am sure to confirm you want to delete the snapshot.

  8. Click Delete CephFS Snapshot.

    A notification is displayed that the snapshot is deleted successfully.

13.5. Scheduling CephFS snapshots

As a storage administrator, you can schedule Ceph File System (CephFS) snapshots on the Red Hat Ceph Storage dashboard.

Scheduling Ceph File System (CephFS) snapshots ensures consistent reliable backups at regular intervals, reducing the risk of data loss. Scheduling snapshots also provides ease of management by reducing administrative overhead of manually managing backups.

A list of available snapshots for a particular file system, subvolume, or directory is found on the File > File Systems page. Use the snapshot list for creating scheduled backups.

13.5.1. Creating CephFS snapshot schedule

As a storage administrator, you can create Ceph File System (CephFS) snapshot schedules on the Red Hat Ceph Storage dashboard.

Create a policy for automatic creation of Ceph File System (CephFS) snapshot of a volume or a certain directory. You can also define how often you want to schedule it (for example: every hour, every day, every week, etc.)

You can specify the number of snapshots or a period for which you want to keep the snapshots. All the older snapshots are deleted when the number of snapshots exceeds or when the retention period is over

Prerequisites

  • A running Red Hat Ceph Storage cluster.

Procedure

  1. From the dashboard navigation, go to File > File Systems.

    File system volumes are listed. Select the file system where you want to create the snapshot schedule.

  2. Go to Snapshot schedules tab.

    Note

    The Enable is available only if the snapshot_scheduler is disabled on the cluster. .. Optional: Click Enable to enable the snapshot_scheduler module. .. After enabling the scheduler, wait for the dashboard to reload and navigate back to the Snapshot schedule page. .. Click 'Create'.

    + The Create Snapshot schedule form opens.

    1. Enter the directory name, start date, start time, and schedule.

      1. Directory: You can search by typing in the path of the directory or subvolume and select the directory from the suggested list where you want to create the snapshot schedule.
      2. Start date: Enter date on which you want the scheduler to start creating the snapshots. By default the current date is selected.
      3. Start time: Enter the time at which you want the scheduler to start creating the snapshots. By default the current time is added.
      4. Schedule: Enter the number of snapshots and the frequency at which you want to create the snapshots. Frequency can be hourly, daily, weekly, monthly, yearly or lastest snapshots.
  3. Optional: Click Add retention policy if you want to add retention policy to the schedule. You can add multiple retention policies. Enter the number of snapshots and the frequency at which you want to retain the snapshots. Frequency can be hourly, daily, weekly, monthly, yearly or lastest snapshots.

  4. Click Create snapshot schedule.

    A notification is displayed that the snapshot schedule is created successfully.

13.5.2. Editing CephFS snapshot schedule

As a storage administrator, you can edit Ceph File System (CephFS) snapshot schedules on the IBM Storage Ceph dashboard. You can only edit the retention policy of the snapshot schedule. You can add another retention policy or delete the existing policy.

Prerequisites

  • A running Red Hat Ceph Storage cluster.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. Select the CephFS where you want to edit snapshot schedules and click Snapshot schedules.
  3. Select the snapshot schedule that you want to edit.
  4. Click 'Edit'. An Edit Snapshot schedule dialog box appears.

  5. Optional: From the Edit Snapshot schedule dialog, add a schedule retention policy, by selecting Add retention policy.

    Enter the number of snapshots and the frequency at which you want to retain the snapshots. Frequency can be one of the following. .. Weekly or lastest snapshots. For example, enter the number of snapshots as 10 and select 'latest snapshots' to retain last 10 snapshots irrespective of the frequency at which they were created. .. Daily .. Hourly .. Monthly .. Yearly

  6. Click 'Edit snapshot schedule' to save.

    A notification is displayed that the retention policy is created successfully.

  7. Click the trash icon to delete the existing retention policy.

    A notification is displayed that the retention policy is deleted successfully.

13.5.3. Deleting CephFS snapshot schedule

As a storage administrator, you can delete Ceph File System (CephFS) snapshot schedules on the IBM Storage Ceph dashboard.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A snapshot schedule.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. Select the CephFS where you want to edit snapshot schedules.
  3. Click 'Snapshot schedules'.
  4. Select the snapshot schedule that you want to delete.
  5. Click 'Edit' from the dropdown menu.

  6. Click 'Delete'.

    A Delete Snapshot schedule dialog box appears.

  7. Select Yes, I am sure to confirm if you want to delete the schedule.

  8. Click 'Delete' snapshot schedule.

    A notification is displayed that the snapshot schedule is deleted successfully.

13.5.4. Deactivating and activating CephFS snapshot schedule

As a storage administrator, you can deactivate and activate Ceph File System (CephFS) snapshot schedules on the IBM Storage Ceph dashboard. The snapshot schedule is activated by default and runs according to how it is configured. Deactivating excludes the snapshot from scheduling until it is activated again.

Prerequisites

  • A running Red Hat Ceph Storage cluster.
  • A snapshot schedule.

Procedure

  1. From the dashboard navigation, go to File > File Systems.
  2. Select the CephFS where you want to edit snapshot schedules.
  3. Click 'Snapshot schedules'.
  4. Select the snapshot schedule that you want to deactivate and click 'Deactivate' from the action drop-down.
  5. Select Yes, I am sure to confirm if you want to deactivate the schedule.

  6. Click 'Deactivate snapshot schedule'.

    A notification is displayed that the snapshot schedule is deactivated successfully.

  7. You can activate the snapshot schedule by clicking 'Activate' in the action drop-down.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.