fix: cleanup and add documentation

Signed-off-by: Paul Kroeher <paul.kroeher@cyberus-technology.de>

On-behalf-of: SAP paul.kroeher@sap.com

Author: pkr4711

checks/default.nix

@@ -6,7 +6,6 @@
     hooks = {
       nixfmt-rfc-style.enable = true;
       deadnix.enable = true;
-      # typos.enable = true;
       typos = {
         enable = true;
         settings.configPath = "checks/.typos.toml";

modules/controller/openstack-controller.nix

@@ -34,8 +34,6 @@ in
     (import ./neutron.nix { inherit neutron; })
     (import ./horizon.nix { inherit horizon; })
     (import ./cinder.nix { inherit cinder; }) # only cinder management component
-    # deploy real storage backend into a separate storageNode
-    # (import ../storage/cinder-storage-node.nix { inherit cinder; })
   ];
 
   config = {

modules/testing/README.md

@@ -12,14 +12,68 @@ ssh root@localhost -p 2022 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/de
 ssh root@localhost -p 1122 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null
 ```
 
-# Cinder & tgtd
+# Cinder & NFS backend
 
 ## Create volume
 
 * login in to `controllerVM` or `storageVM`
 
 ```bash
-openstack volume create --size 4 TEST_VOL
+openstack volume create --size 4 test_vol
+```
+
+* Cinder will create a volume on the mounted nfs share. `/var/lib/cinder/mnt/8216055ab12dc06650bdd79b0d5a6c84`
+* The storageVM provides the nfs share itself from `/dev/vdb` mounted on `/exports`
+
+## Assign volume to a VM
+
+* create a new VM with: `openstack server create`
+  * or look into system unit: `openstack-create-vm` on VM `controllerVM`
+
+* attach volume to vm
+
+```bash
+openstack server list
+openstack volume list
+openstack server add volume <INSTANCE_NAME_OR_ID> <VOLUME_NAME_OR_ID>
+```
+
+* Verify if the nfs store is mounted on the `computeVM`
+
+```bash
+[root@computeVM:~]# df -h | grep export
+10.0.0.20:/exports        503G  2.0M  503G   1% /var/lib/nova/mnt/8216055ab12dc06650bdd79b0d5a6c84
+```
+
+* Verify block device mapping is working in the test VM.
+
+```bash
+[root@controllerVM:~]# openstack server list
++--------------------------------------+---------+--------+------------------------+--------+---------+
+| ID                                   | Name    | Status | Networks               | Image  | Flavor  |
++--------------------------------------+---------+--------+------------------------+--------+---------+
+| fd43f442-d482-49bf-a4d8-a19ac03e36c3 | test_vm | ACTIVE | provider=192.168.44.85 | cirros | m1.nano |
++--------------------------------------+---------+--------+------------------------+--------+---------+
+
+NETNS=$(ip netns list | cut -f 1 -d ' ')
+VMIP=$(openstack server show test_vm -f value -c addresses | cut -f 4 -d "'")
+ip netns exec $NETNS ssh cirros@${VMIP} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null lsblk
+
+NAME    MAJ:MIN RM  SIZE RO TYPE MOUNTPOINTS
+vda     252:0    0  112M  0 disk
+|-vda1  252:1    0  103M  0 part /
+`-vda15 252:15   0    8M  0 part
+vdb     252:16   0    4G  0 disk
+```
+
+# Cinder & tgtd backend
+
+## Create volume
+
+* login in to `controllerVM` or `storageVM`
+
+```bash
+openstack volume create --size 4 test_vol
 ```
 
 * Cinder will create a LVM logical volume in the volume group `cinder-volumes`.

modules/testing/default.nix

@@ -42,11 +42,6 @@ let
         users.users.root.hashedPassword = lib.mkForce "$y$j9T$HiT/m702z/73g4Dt5RzbW0$b3SaYI1FoyT/ORV/qFR/s9zonJBKDn4p2XKyYM2wp1.";
         users.users.root.hashedPasswordFile = null;
 
-        # enable easy access to test VMs with ssh
-        # users.users.root.openssh.authorizedKeys.keys = [
-        #
-        # ];
-
         services.openssh = {
           enable = true;
           ports = [ 22 ];