Skip to content

Commit ff6abe9

Browse files
committed
Update documentation for Manila and Ceph
1 parent 92a30f0 commit ff6abe9

File tree

2 files changed

+49
-5
lines changed

2 files changed

+49
-5
lines changed

doc/source/configuration/cephadm.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,50 @@ post-deployment configuration is applied. Commands in the
262262
``cephadm_commands_post`` list are executed after the rest of the Ceph
263263
post-deployment configuration is applied.
264264

265+
Manila & CephFS
266+
~~~~~~~~~~~~~~~
267+
268+
Using Manila with the CephFS backend requires the configuration of additional
269+
resources.
270+
271+
A Manila key should be added to cephadm_keys:
272+
273+
.. code:: yaml
274+
275+
# Append the following to cephadm_keys:
276+
- name: client.manila
277+
caps:
278+
mon: "allow r"
279+
mgr: "allow rw"
280+
state: present
281+
282+
A CephFS filesystem requires two pools, one for metadata and one for data:
283+
284+
.. code:: yaml
285+
286+
# Append the following to cephadm_pools:
287+
- name: cephfs_data
288+
application: cephfs
289+
state: present
290+
- name: cephfs_metadata
291+
application: cephfs
292+
state: present
293+
294+
Finally, the CephFS filesystem itself should be created:
295+
296+
.. code:: yaml
297+
298+
# Append the following to cephadm_commands_post:
299+
- "fs new manila-cephfs cephfs_metadata cephfs_data"
300+
- "orch apply mds manila-cephfs"
301+
302+
In this example, the filesystem is named ``manila-cephfs``. This name
303+
should be used in the Kolla Manila configuration e.g.:
304+
305+
.. code:: yaml
306+
307+
manila_cephfs_filesystem_name: manila-cephfs
308+
265309
Deployment
266310
==========
267311

doc/source/contributor/environments/ci-multinode.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ Config changes
3838
3. Also under vxlan_interfaces, add vni:x where x is between 500 and 1000
3939
4. Also under vxlan_interfaces, check vxlan_dstport is not 4789 (this causes
4040
conflicts, change to 4790)
41-
5. In /etc/kayobe/environments/ci-multinode/tf-networks.yml, edit admin_ips so
41+
5. In etc/kayobe/environments/ci-multinode/tf-networks.yml, edit admin_ips so
4242
that the compute and controller IPs line up with the
4343
instances that were created earlier, remove the other IPs for seed and
4444
cephOSD
45-
6. In /etc/kayobe/environments/ci-multinode/network-allocation.yml, remove all
45+
6. In etc/kayobe/environments/ci-multinode/network-allocation.yml, remove all
4646
the entries and just assign ``aio_ips:`` an empty set ``[]``
4747
7. In etc/kayobe/environments/ci-multinode/inventory/hosts, remove the seed
4848
8. run stackhpc-kayobe-config/etc/kayobe/ansible/growroot.yml (if this fails,
@@ -59,7 +59,7 @@ Manila
5959
======
6060
The Multinode environment supports Manila with the CephFS native backend, but it
6161
is not enabled by default. To enable it, set the following in
62-
``/etc/kayobe/environments/ci-multinode/kolla.yml``:
62+
``etc/kayobe/environments/ci-multinode/kolla.yml``:
6363

6464
.. code-block:: yaml
6565
@@ -71,7 +71,7 @@ deployment.
7171

7272
To test it, you will need two virtual machines. Cirros does not support the Ceph
7373
kernel client, so you will need to use a different image. Any regular Linux
74-
distribution should work. As an example, we will use Ubuntu 20.04.
74+
distribution should work. As an example, this guide will use Ubuntu 20.04.
7575

7676
Download the image locally:
7777

@@ -133,7 +133,7 @@ Back on the host, install the Manila client:
133133

134134
.. code-block:: bash
135135
136-
sudo dnf install -y python-manilaclient
136+
pip install python-manilaclient
137137
138138
Then create a share type and share:
139139

0 commit comments

Comments
 (0)