CephFS: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(→‎Create Share: added availability zone setting)
(Marked this version for translation)
 
(95 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Draft}}
<languages />


= User Guide to Provisioning and Deploying CephFS =
<translate>


== Introduction ==
<!--T:1-->
CephFS provides a common filesystem that can be shared amongst multiple OpenStack VM hosts. Access to the service is granted via requests to [mailto:cloud@tech.alliancecan.ca cloud@tech.alliancecan.ca].


CephFS provides a common filesystem that can be shared amongst multiple openstack vm hosts. Access to the service is granted via requests to cloud@computecanada.ca.
<!--T:2-->
This is a fairly technical procedure that assumes basic Linux skills for creating/editing files, setting permissions, and creating mount points. For assistance in setting up this service, write to [mailto:cloud@tech.alliancecan.ca cloud@tech.alliancecan.ca].


This is a fairly technical procedure that assumes basic linux skills for creating/editing files, setting permissions and creating mount points. Contact your technical resource for your project for assistance in setting up this service.
=Procedure= <!--T:3-->


== Technical Procedure ==
==Request access to shares == <!--T:4-->


=== Request Access to Shares ===
<!--T:5-->
If you do not already have a quota for the service, you will need to request this through [mailto:cloud@tech.alliancecan.ca cloud@tech.alliancecan.ca]. In your request please provide the following:
* OpenStack project name
* amount of quota required (in GB)
* number of shares required


* If you do not already have a quota for the service you will need to request this through cloud@computecanada.ca.
== OpenStack configuration: Create a CephFS share == <!--T:6-->
** In your request provide the following:
*** Project name
*** Expected file system share name.
**** This should be the name of the project followed by a unique name for the share (e.g. def-smith-WebServerShare).
*** Approximate size of share in GB.


=== Create Share ===
<!--T:7-->
; Create the share.
: In <i>Project --> Share --> Shares</i>, click on <i>+Create Share</i>.
: <i>Share Name</i> = enter a name that identifies your project (e.g. <i>project-name-shareName</i>)
: <i>Share Protocol</i> = CephFS
: <i>Size</i> = size you need for this share
: <i>Share Type</i> = cephfs
: <i>Availability Zone</i> = nova
: Do not check <i>Make visible for all</i>, otherwise the share will be accessible by all users in all projects.
: Click on the <i>Create</i> button.
[[File:Cephfs config.png|450px|thumb|left|Configuration of CephFS on Horizon GUI]]
<br clear=all>


# Create a share in &quot;Shares&quot; under the &quot;Share&quot; menu:
<!--T:20-->
#* Give this a name that identifies your project: project-name-shareName
; Create an access rule to generate access key.
#** e.g. def-smith-WebServerShare
: In <i>Project --> Share --> Shares --> Actions</i> column, select <i>Manage Rules</i> from the drop-down menu.
#* Share Protocol = cephfs
: Click on the <i>+Add Rule</i> button (right of the page).
#* Size = size you need for this share
: <i>Access Type</i> = cephx
#* Share Type = cephfs
: <i>Access Level</i> = select <i>read-write</i> or <i>read-only</i> (you can create multiple rules for either access level if required)
#* Availability Zone = nova
: <i>Access To</i> = select a key name that describes the key. This name is important because it will be used in the cephfs client configuration on the VM; on this page, we use <i>MyCephFS-RW</i>.
# Provide the name of your share to the cloud team so they can generate a key for you. Do so by replying to the initial request ticket you opened in the first steps.
[[File:Cephfs created.png|450px|thumb|left||Properly configured CephFS]]
#* You will need to provide the following in your request:
<br clear=all>
#** Share name (e.g. def-smith-WebServerShare).


=== Configure Host ===
<!--T:21-->
; Note the share details which you will need later.
: In <i>Project --> Share --> Shares</i>, click on the name of the share.
: In the <i>Share Overview</i>, note the three elements circled in red in the "Properly configured" image: <i>Path</i>, which will be used in the  mount command on the VM, the <i>Access Rules</i>, which will be the client name and the <i>Access Key</i> that will let the VM's client connect.


<ol>
== Attach the CephFS network to your VM == <!--T:8-->
<li><p>Retrieve Key:</p>
<ul>
<li><p>View the &quot;Share Details&quot; by clicking on the share name in the &quot;Shares&quot; pane.</p>
<ul>
<li>Key is located under the &quot;Access Rules&quot; section labeled &quot;Access Key&quot;.</li></ul>
</li>
<li><p>Create two files each containing the key provided.</p></li>
<li><p>File 1: /etc/ceph/client.fullkey.shareName (e.g. client.fullkey.WebServerShare)</p>
<ul>
<li>contents:
<pre>[client.shareName]
    key = KeyProvidedByAdmin
</pre></li></ul>
</li>
<li><p>File 2: /etc/ceph/client.keyonly.shareName (e.g client.keyonly.WebServerShare)</p>
<ul>
<li>contents:
<pre>KeyProvidedByAdmin
</pre></li>
<li>This file only contains the key provided by the admin</li></ul>
</li>
<li><p>Own these files correctly to protect the key information:</p>
<ul>
<li>Each file should be own to root (sudo chown root.root filename).</li>
<li>Each file should be only readable by root (sudo chmod 600 filename).</li></ul>
</li></ul>
</li>
<li><p>Create <code>/etc/ceph/ceph.conf</code> with contents:</p>
<pre>[client]
    client quota = true
    mon host = 10.30.201.3:6789,10.30.202.3:6789,10.30.203.3:6789
</pre>
<ul>
<li>Note: these are the monitors for the Arbutus cluster - if connecting to a different cluster you will need the monitor information specific to that cluster.
<ul>
<li>You can find the monitor information in the Share Details for your share in the &quot;Path&quot; field.</li></ul>
</li></ul>
</li>
<li><p>Install required packages</p></li></ol>


<ul>
=== On Arbutus === <!--T:22-->
<li><p>Red Hat Family (RHEL, CentOS, Fedora, Scientific Linux, SUSE, etc.): 1. Install relevant repos for access to ceph client packages: <code>ceph-stable (nautilus is current as of this writting) epel</code> 1. Install packages to enable the ceph client on all the VMs you plan on mounting the share: <code>libcephfs2 python-cephfs ceph-common python-ceph-argparse ceph-fuse (only if you intend a fuse mount)</code></p></li>
On <code>Arbutus</code>, the cephFS network is already exposed to your VM; there is nothing to do here, '''[[CephFS#VM_configuration:_install_and_configure_CephFS_client|go to the VM configuration section]]'''.
<li><p>Debian Family (Debian, Ubuntu, Mint, etc.):</p>
<pre>sudo apt install ceph-common
</pre></li></ul>


# Retrieve the connection information from the share page for your connection:
=== On SD4H/Juno === <!--T:23-->
#* Open up the share details by clicking the name of the share in the Shares page.
On <code>SD4H/Juno</code>, you need to explicitly attach the cephFS network to the VM.
#* Copy the entire path of the share for mounting the filesystem.
# Mount the filesystem
#* Create mount point directory somewhere in your host (likely under /mnt/ - e.g. /mnt/ShareName)
#* Via kernel mount using the ceph driver:
#** Syntax: <code>sudo mount -t ceph &lt; path information&gt; &lt; mountPoint &gt; -o name=&lt; shareKeyName &gt;, secretfile=&lt; /path/to/keyringfileOnlyFile &gt;</code>
#** <code>sudo mount -t ceph mon1:6789,mon2:6789,mon3:6789:/volumes/_nogroup/share_instance_id </code>
#*** e.g <code>sudo mount -t ceph 192.168.17.13:6789,192.168.17.14:6789,192.168.17.15:6789:/volumes/_nogroup/a87b5ef3-b266-4664-a5ed-026cddfdcdb7 /mnt/WebServerShare -o name=def-smith,secretfile=/etc/ceph/client.keyonly.WebServerShare</code>
#* Via ceph-fuse
#** Need to install ceph-fuse
#** Syntax: <code>sudo ceph-fuse &lt; mountPoint &gt; --id=&lt; projectName &gt; --conf=&lt; pathtoCeph.conf &gt; --keyring=&lt; fullKeyringLocation &gt; --client-mountpoint=pathFromShareDetails</code>
#*** e.g. <code>sudo ceph-fuse /mnt/WebServerShare --id=def-smith --conf=/etc/ceph/ceph.conf --keyring=/etc/ceph/client.fullkey.WebServerShare --client-mountpoint=/volumes/_nogroup/a87b5ef3-b266-4664-a5ed-026cddfdcdb7</code>


== Notes ==
<!--T:24-->
;With the Web Gui
For each VM you need to attach, select <i>Instance --> Action --> Attach interface</i>  select the CephFS-Network, leave the <i>Fixed IP Address</i> box empty.
[[File:Select CephFS Network.png|750px|thumb|left|]]
<br clear=all>
;With the [[OpenStack_command_line_clients|Openstack client]]
List the servers and select the id of the server you need to attach to the CephFS
<source lang='bash'>
$ openstack  server list
+--------------------------------------+--------------+--------+-------------------------------------------+--------------------------+----------+
| ID                                  | Name        | Status | Networks                                  | Image                    | Flavor  |
+--------------------------------------+--------------+--------+-------------------------------------------+--------------------------+----------+
| 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 | prune-dtn1  | ACTIVE | test_network=172.16.1.86, 198.168.189.3  | N/A (booted from volume) | ha4-15gb |
| 0c6df8ea-9d6a-43a9-8f8b-85eb64ca882b | prune-mgmt1  | ACTIVE | test_network=172.16.1.64                  | N/A (booted from volume) | ha4-15gb |
| 2b7ebdfa-ee58-4919-bd12-647a382ec9f6 | prune-login1 | ACTIVE | test_network=172.16.1.111, 198.168.189.82 | N/A (booted from volume) | ha4-15gb |
+--------------------------------------+--------------+--------+----------------------------------------------+--------------------------+----------+
</source>


* A particular share can have more than one user key provisioned for it.
<!--T:25-->
** This allows a more granular access to the filesystem.
Select the ID of the VM you want to attach, will pick the first one here and run
** For example, if you needed some hosts to only access the filesystem in a read only capacity.
<source lang='bash'>
** If you have multiple keys for a share you can add the extra keys to your host and modify the above mounting procedure.
$ openstack  server add network 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 CephFS-Network
* This service is not available to hosts outside of the Openstack cluster.
$ openstack  server list
+--------------------------------------+--------------+--------+---------------------------------------------------------------------+--------------------------+----------+
| ID                                  | Name        | Status | Networks                                                            | Image                    | Flavor  |
+--------------------------------------+--------------+--------+---------------------------------------------------------------------+--------------------------+----------+
| 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 | prune-dtn1  | ACTIVE | CephFS-Network=10.65.20.71; test_network=172.16.1.86, 198.168.189.3 | N/A (booted from volume) | ha4-15gb |
| 0c6df8ea-9d6a-43a9-8f8b-85eb64ca882b | prune-mgmt1  | ACTIVE | test_network=172.16.1.64                                            | N/A (booted from volume) | ha4-15gb |
| 2b7ebdfa-ee58-4919-bd12-647a382ec9f6 | prune-login1 | ACTIVE | test_network=172.16.1.111, 198.168.189.82                          | N/A (booted from volume) | ha4-15gb |
+--------------------------------------+--------------+--------+------------------------------------------------------------------------+--------------------------+----------+
</source>
 
<!--T:26-->
We can see that the CephFS network is attached to the first VM.
 
== VM configuration: install and configure CephFS client == <!--T:9-->
 
=== Required packages for the Red Hat family (RHEL, CentOS, Fedora, Rocky, Alma ) === <!--T:27-->
Check the available releases at [https://download.ceph.com/ https://download.ceph.com/] and look for recent <code>rpm-*</code> directories.
As of July 2024, <code>quincy</code> is the latest stable release.
The compatible distributions (distros) are listed at [https://download.ceph.com/rpm-quincy/ https://download.ceph.com/rpm-quincy/].
Here we show configuration examples for <code>Enterprise Linux 8</code> and <code>Enterprise Linux 9</code>.
 
<!--T:28-->
; Install relevant repositories for access to ceph client packages:
 
<!--T:29-->
<tabs>
<tab name="Enterprise Linux 8 - el8">
{{File
  |name=/etc/yum.repos.d/ceph.repo
  |lang="ini"
  |contents=
[Ceph]
name=Ceph packages for $basearch
baseurl=http://download.ceph.com/rpm-quincy/el8/$basearch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
 
<!--T:51-->
[Ceph-noarch]
name=Ceph noarch packages
baseurl=http://download.ceph.com/rpm-quincy/el8/noarch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
 
<!--T:52-->
[ceph-source]
name=Ceph source packages
baseurl=http://download.ceph.com/rpm-quincy/el8/SRPMS
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
}}
</tab>
<tab name="Enterprise Linux 9 - el9">
{{File
  |name=/etc/yum.repos.d/ceph.repo
  |lang="ini"
  |contents=
[Ceph]
name=Ceph packages for $basearch
baseurl=http://download.ceph.com/rpm-quincy/el9/$basearch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
 
<!--T:53-->
[Ceph-noarch]
name=Ceph noarch packages
baseurl=http://download.ceph.com/rpm-quincy/el9/noarch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
 
<!--T:54-->
[ceph-source]
name=Ceph source packages
baseurl=http://download.ceph.com/rpm-quincy/el9/SRPMS
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc
}}
</tab>
</tabs>
 
<!--T:32-->
The epel repo also needs to be in place
sudo dnf install epel-release
 
<!--T:33-->
You can now install the ceph lib, cephfs client and other dependencies:
sudo dnf install -y libcephfs2 python3-cephfs ceph-common python3-ceph-argparse
 
 
=== Required packages for the Debian family (Debian, Ubuntu, Mint, etc.) === <!--T:34-->
You can get the repository once you have figured out your distro <code>{codename}</code> with <code>lsb_release -sc</code>
<source lang='bash'>
sudo apt-add-repository 'deb https://download.ceph.com/debian-quincy/ {codename} main'
</source>
 
<!--T:50-->
You can now install the ceph lib, cephfs client and other dependencies:
<source lang='bash'>
sudo apt-get install -y libcephfs2 python3-cephfs ceph-common python3-ceph-argparse
</source>
 
=== Configure ceph client === <!--T:35-->
 
<!--T:36-->
Once the client is installed, you can create a <code>ceph.conf</code> file.
Note the different <code>mon host</code> for the different cloud.
<tabs>
<tab name="Arbutus">
{{File
  |name=/etc/ceph/ceph.conf
  |lang="ini"
  |contents=
[global]
admin socket = /var/run/ceph/$cluster-$name-$pid.asok
client reconnect stale = true
debug client = 0/2
fuse big writes = true
mon host = 10.30.201.3:6789,10.30.202.3:6789,10.30.203.3:6789
[client]
quota = true
}}
</tab>
<tab name="SD4H/Juno">
{{File
  |name=/etc/ceph/ceph.conf
  |lang="ini"
  |contents=
[global]
admin socket = /var/run/ceph/$cluster-$name-$pid.asok
client reconnect stale = true
debug client = 0/2
fuse big writes = true
mon host = 10.65.0.10:6789,10.65.0.12:6789,10.65.0.11:6789
[client]
quota = true
}}
</tab>
</tabs>
 
<!--T:37-->
You can find the monitor information in the share details <i>Path</i> field that will be used to mount the volume. If the value of the web page is different than what is seen here, it means that the wiki page is out of date.
 
<!--T:38-->
You also need to put your client name and secret in the <code>ceph.keyring</code> file
 
<!--T:39-->
{{File
  |name=/etc/ceph/ceph.keyring
  |lang="ini"
  |contents=
[client.MyCephFS-RW]
    key = <access Key>
}}
 
<!--T:40-->
Again, the access key and client name (here MyCephFS-RW) are found under the access rules on your project web page.
Look for <i>Project --> Share --> Shares</i>, then click on the name of the share.
 
<!--T:41-->
; Retrieve the connection information from the share page for your connection:
: Open up the share details by clicking on the name of the share in the <i>Shares</i> page.
: Copy the entire path of the share to mount the filesystem.
 
<!--T:42-->
;Mount the filesystem
:Create a mount point directory somewhere in your host (<code>/cephfs</code>, is used here)</li>
<source lang="bash">
mkdir /cephfs
</source>
:You can use the ceph driver to permanently mount your CephFS device by adding the following in the VM fstab
<tabs>
<tab name="Arbutus">
{{File
  |name=/etc/fstab
  |lang="txt"
  |contents=
:/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ ceph name=MyCephFS-RW 0  2
}}
</tab>
<tab name="SD4H/Juno">
{{File
  |name=/etc/fstab
  |lang="txt"
  |contents=
:/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ ceph name=MyCephFS-RW,mds_namespace=cephfs_4_2,x-systemd.device-timeout=30,x-systemd.mount-timeout=30,noatime,_netdev,rw 0  2
}}
</tab>
</tabs>
 
<!--T:43-->
'''Notice''' the non-standard <code>:</code> before the device path. It is not a typo!
The mount options are different on different systems.
The namespace option is required for SD4H/Juno, while other options are performance tweaks.
 
<!--T:44-->
You can also do the mount directly from the command line:
<tabs>
<tab name="Arbutus">
<code>
sudo mount -t ceph :/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ -o name=MyCephFS-RW
</code>
</tab>
<tab name="SD4H/Juno">
<code>
sudo mount -t ceph :/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ -o name=MyCephFS-RW,mds_namespace=cephfs_4_2,x-systemd.device-timeout=30,x-systemd.mount-timeout=30,noatime,_netdev,rw
</code>
</tab>
</tabs>
 
<!--T:45-->
CephFS is can also be mounted directly in user space via ceph-fuse.
 
<!--T:46-->
Install the ceph-fuse lib
 
<!--T:47-->
<source lang="bash">
sudo dnf install ceph-fuse
</source>
Let the fuse mount be accessible in userspace by uncommenting  <code>user_allow_other</code> in the <code>fuse.conf</code> file.
 
<!--T:48-->
{{File
  |name=/etc/fuse.conf
  |lang="txt"
  |contents=
# mount_max = 1000
user_allow_other
}}
 
<!--T:49-->
You can now mount cephFS in a user’s home:
<source lang="bash">
mkdir ~/my_cephfs
ceph-fuse my_cephfs/ --id=MyCephFS-RW --conf=~/ceph.conf --keyring=~/ceph.keyring  --client-mountpoint=/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c
</source>
Note that the client name is here the <code>--id</code>. The <code>ceph.conf</code> and <code>ceph.keyring</code> content are exactly the same as for the ceph kernel mount.
 
=Notes= <!--T:10-->
 
<!--T:11-->
A particular share can have more than one user key provisioned for it. This allows a more granular access to the filesystem, for example, if you needed some hosts to only access the filesystem in a read-only capacity. If you have multiple keys for a share, you can add the extra keys to your host and modify the above mounting procedure. This service is not available to hosts outside of the OpenStack cluster.
 
<!--T:12-->
[[Category:Cloud]]
 
</translate>

Latest revision as of 18:59, 16 October 2024

Other languages:


CephFS provides a common filesystem that can be shared amongst multiple OpenStack VM hosts. Access to the service is granted via requests to cloud@tech.alliancecan.ca.

This is a fairly technical procedure that assumes basic Linux skills for creating/editing files, setting permissions, and creating mount points. For assistance in setting up this service, write to cloud@tech.alliancecan.ca.

Procedure

Request access to shares

If you do not already have a quota for the service, you will need to request this through cloud@tech.alliancecan.ca. In your request please provide the following:

  • OpenStack project name
  • amount of quota required (in GB)
  • number of shares required

OpenStack configuration: Create a CephFS share

Create the share.
In Project --> Share --> Shares, click on +Create Share.
Share Name = enter a name that identifies your project (e.g. project-name-shareName)
Share Protocol = CephFS
Size = size you need for this share
Share Type = cephfs
Availability Zone = nova
Do not check Make visible for all, otherwise the share will be accessible by all users in all projects.
Click on the Create button.
Configuration of CephFS on Horizon GUI


Create an access rule to generate access key.
In Project --> Share --> Shares --> Actions column, select Manage Rules from the drop-down menu.
Click on the +Add Rule button (right of the page).
Access Type = cephx
Access Level = select read-write or read-only (you can create multiple rules for either access level if required)
Access To = select a key name that describes the key. This name is important because it will be used in the cephfs client configuration on the VM; on this page, we use MyCephFS-RW.
Properly configured CephFS


Note the share details which you will need later.
In Project --> Share --> Shares, click on the name of the share.
In the Share Overview, note the three elements circled in red in the "Properly configured" image: Path, which will be used in the mount command on the VM, the Access Rules, which will be the client name and the Access Key that will let the VM's client connect.

Attach the CephFS network to your VM

On Arbutus

On Arbutus, the cephFS network is already exposed to your VM; there is nothing to do here, go to the VM configuration section.

On SD4H/Juno

On SD4H/Juno, you need to explicitly attach the cephFS network to the VM.

With the Web Gui

For each VM you need to attach, select Instance --> Action --> Attach interface select the CephFS-Network, leave the Fixed IP Address box empty.

Select CephFS Network.png


With the Openstack client

List the servers and select the id of the server you need to attach to the CephFS 

$ openstack  server list 
+--------------------------------------+--------------+--------+-------------------------------------------+--------------------------+----------+
| ID                                   | Name         | Status | Networks                                  | Image                    | Flavor   |
+--------------------------------------+--------------+--------+-------------------------------------------+--------------------------+----------+
| 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 | prune-dtn1   | ACTIVE | test_network=172.16.1.86, 198.168.189.3   | N/A (booted from volume) | ha4-15gb |
| 0c6df8ea-9d6a-43a9-8f8b-85eb64ca882b | prune-mgmt1  | ACTIVE | test_network=172.16.1.64                  | N/A (booted from volume) | ha4-15gb |
| 2b7ebdfa-ee58-4919-bd12-647a382ec9f6 | prune-login1 | ACTIVE | test_network=172.16.1.111, 198.168.189.82 | N/A (booted from volume) | ha4-15gb |
+--------------------------------------+--------------+--------+----------------------------------------------+--------------------------+----------+

Select the ID of the VM you want to attach, will pick the first one here and run 

$ openstack  server add network 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 CephFS-Network
$ openstack  server list 
+--------------------------------------+--------------+--------+---------------------------------------------------------------------+--------------------------+----------+
| ID                                   | Name         | Status | Networks                                                            | Image                    | Flavor   |
+--------------------------------------+--------------+--------+---------------------------------------------------------------------+--------------------------+----------+
| 1b2a3c21-c1b4-42b8-9016-d96fc8406e04 | prune-dtn1   | ACTIVE | CephFS-Network=10.65.20.71; test_network=172.16.1.86, 198.168.189.3 | N/A (booted from volume) | ha4-15gb |
| 0c6df8ea-9d6a-43a9-8f8b-85eb64ca882b | prune-mgmt1  | ACTIVE | test_network=172.16.1.64                                            | N/A (booted from volume) | ha4-15gb |
| 2b7ebdfa-ee58-4919-bd12-647a382ec9f6 | prune-login1 | ACTIVE | test_network=172.16.1.111, 198.168.189.82                           | N/A (booted from volume) | ha4-15gb |
+--------------------------------------+--------------+--------+------------------------------------------------------------------------+--------------------------+----------+

We can see that the CephFS network is attached to the first VM.

VM configuration: install and configure CephFS client

Required packages for the Red Hat family (RHEL, CentOS, Fedora, Rocky, Alma )

Check the available releases at https://download.ceph.com/ and look for recent rpm-* directories. As of July 2024, quincy is the latest stable release. The compatible distributions (distros) are listed at https://download.ceph.com/rpm-quincy/. Here we show configuration examples for Enterprise Linux 8 and Enterprise Linux 9.

Install relevant repositories for access to ceph client packages
File : /etc/yum.repos.d/ceph.repo

[Ceph]
name=Ceph packages for $basearch
baseurl=http://download.ceph.com/rpm-quincy/el8/$basearch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc

[Ceph-noarch]
name=Ceph noarch packages
baseurl=http://download.ceph.com/rpm-quincy/el8/noarch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc

[ceph-source]
name=Ceph source packages
baseurl=http://download.ceph.com/rpm-quincy/el8/SRPMS
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc


File : /etc/yum.repos.d/ceph.repo

[Ceph]
name=Ceph packages for $basearch
baseurl=http://download.ceph.com/rpm-quincy/el9/$basearch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc

[Ceph-noarch]
name=Ceph noarch packages
baseurl=http://download.ceph.com/rpm-quincy/el9/noarch
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc

[ceph-source]
name=Ceph source packages
baseurl=http://download.ceph.com/rpm-quincy/el9/SRPMS
enabled=1
gpgcheck=1
type=rpm-md
gpgkey=https://download.ceph.com/keys/release.asc


The epel repo also needs to be in place 

sudo dnf install epel-release

You can now install the ceph lib, cephfs client and other dependencies: 

sudo dnf install -y libcephfs2 python3-cephfs ceph-common python3-ceph-argparse


Required packages for the Debian family (Debian, Ubuntu, Mint, etc.)

You can get the repository once you have figured out your distro {codename} with lsb_release -sc 

sudo apt-add-repository 'deb https://download.ceph.com/debian-quincy/ {codename} main'

You can now install the ceph lib, cephfs client and other dependencies: 

 sudo apt-get install -y libcephfs2 python3-cephfs ceph-common python3-ceph-argparse

Configure ceph client

Once the client is installed, you can create a ceph.conf file. Note the different mon host for the different cloud.

File : /etc/ceph/ceph.conf

[global]
admin socket = /var/run/ceph/$cluster-$name-$pid.asok
client reconnect stale = true
debug client = 0/2
fuse big writes = true
mon host = 10.30.201.3:6789,10.30.202.3:6789,10.30.203.3:6789
[client]
quota = true


File : /etc/ceph/ceph.conf

[global]
admin socket = /var/run/ceph/$cluster-$name-$pid.asok
client reconnect stale = true
debug client = 0/2
fuse big writes = true
mon host = 10.65.0.10:6789,10.65.0.12:6789,10.65.0.11:6789
[client]
quota = true


You can find the monitor information in the share details Path field that will be used to mount the volume. If the value of the web page is different than what is seen here, it means that the wiki page is out of date.

You also need to put your client name and secret in the ceph.keyring file


File : /etc/ceph/ceph.keyring

[client.MyCephFS-RW]
    key = <access Key>


Again, the access key and client name (here MyCephFS-RW) are found under the access rules on your project web page. Look for Project --> Share --> Shares, then click on the name of the share.

Retrieve the connection information from the share page for your connection
Open up the share details by clicking on the name of the share in the Shares page.
Copy the entire path of the share to mount the filesystem.
Mount the filesystem
Create a mount point directory somewhere in your host (/cephfs, is used here)
 mkdir /cephfs
You can use the ceph driver to permanently mount your CephFS device by adding the following in the VM fstab
File : /etc/fstab

:/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ ceph name=MyCephFS-RW 0  2


File : /etc/fstab

:/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ ceph name=MyCephFS-RW,mds_namespace=cephfs_4_2,x-systemd.device-timeout=30,x-systemd.mount-timeout=30,noatime,_netdev,rw 0  2


Notice the non-standard : before the device path. It is not a typo! The mount options are different on different systems. The namespace option is required for SD4H/Juno, while other options are performance tweaks.

You can also do the mount directly from the command line:

sudo mount -t ceph :/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ -o name=MyCephFS-RW

sudo mount -t ceph :/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c /cephfs/ -o name=MyCephFS-RW,mds_namespace=cephfs_4_2,x-systemd.device-timeout=30,x-systemd.mount-timeout=30,noatime,_netdev,rw

CephFS is can also be mounted directly in user space via ceph-fuse.

Install the ceph-fuse lib 

sudo dnf install ceph-fuse

Let the fuse mount be accessible in userspace by uncommenting user_allow_other in the fuse.conf file.


File : /etc/fuse.conf

# mount_max = 1000
user_allow_other


You can now mount cephFS in a user’s home: 

mkdir ~/my_cephfs
ceph-fuse my_cephfs/ --id=MyCephFS-RW --conf=~/ceph.conf --keyring=~/ceph.keyring   --client-mountpoint=/volumes/_nogroup/f6cb8f06-f0a4-4b88-b261-f8bd6b03582c

Note that the client name is here the --id. The ceph.conf and ceph.keyring content are exactly the same as for the ceph kernel mount.

Notes

A particular share can have more than one user key provisioned for it. This allows a more granular access to the filesystem, for example, if you needed some hosts to only access the filesystem in a read-only capacity. If you have multiple keys for a share, you can add the extra keys to your host and modify the above mounting procedure. This service is not available to hosts outside of the OpenStack cluster.

Retrieved from "https://docs.alliancecan.ca/mediawiki/index.php?title=CephFS&oldid=162511"